Document Service

Document

Este servicio permite que las secuencias de comandos creen, modifiquen y accedan a archivos de Documentos de Google.

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

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

Clases

NombreDescripción breve
AttributeEs una enumeración de los atributos del elemento.
BodyEs el contenido de una pestaña en un documento de Documentos de Google.
BookmarkObjeto que representa un marcador.
ContainerElementEs un elemento genérico que puede contener otros elementos.
DateUn elemento que representa una fecha con formato
DocumentEs un documento que contiene uno o más objetos Tab, cada uno de los cuales contiene texto enriquecido y elementos como tablas y listas.
DocumentAppEl servicio de documentos crea y abre Documents que se puede editar.
DocumentTabPestaña de documento que contiene texto enriquecido y elementos como tablas y listas.
ElementEs un elemento genérico.
ElementTypeEs una enumeración de todos los tipos de elementos.
EquationEs un elemento que representa una expresión matemática.
EquationFunctionEs un elemento que representa una función en un Equation matemático.
EquationFunctionArgumentSeparatorEs un elemento que representa un separador de funciones en un Equation matemático.
EquationSymbolEs un elemento que representa un símbolo en un Equation matemático.
FontFamilyEs una enumeración de las fuentes admitidas.
FooterSectionEs un elemento que representa una sección de pie de página.
FootnoteEs un elemento que representa una nota al pie.
FootnoteSectionEs un elemento que representa una sección de notas al pie.
GlyphTypeEs una enumeración de los tipos de glifos admitidos.
HeaderSectionEs un elemento que representa una sección de encabezado.
HorizontalAlignmentEs una enumeración de los tipos de alineación horizontal admitidos.
HorizontalRuleEs un elemento que representa una regla horizontal.
InlineDrawingEs un elemento que representa un dibujo incorporado.
InlineImageEs un elemento que representa una imagen incorporada.
ListItemEs un elemento que representa un elemento de lista.
NamedRangeUn Range que tiene un nombre y un ID para permitir su recuperación posterior.
PageBreakEs un elemento que representa un salto de página.
ParagraphEs un elemento que representa un párrafo.
ParagraphHeadingEs una enumeración de los encabezados de párrafo estándar.
PersonEs un elemento que representa un vínculo a una persona.
PositionEs una referencia a una ubicación en la pestaña del documento, relativa a un elemento específico.
PositionedImageImagen de posición fija anclada a un Paragraph.
PositionedLayoutEs una enumeración que especifica cómo se debe diseñar un PositionedImage en relación con el texto circundante.
RangeEs un rango de elementos en un documento.
RangeBuilderEs un compilador que se usa para construir objetos Range a partir de elementos de documentos.
RangeElementEs un wrapper alrededor de un Element con un posible desplazamiento de inicio y finalización.
RichLinkEs un elemento que representa un vínculo a un recurso de Google, como un archivo de Drive o un video de YouTube.
TabEs una pestaña dentro de un documento de Documentos de Google.
TabTypeEs una enumeración de todos los tipos de pestañas.
TableEs un elemento que representa una tabla.
TableCellEs un elemento que representa una celda de tabla.
TableOfContentsEs un elemento que contiene un índice.
TableRowEs un elemento que representa una fila de la tabla.
TextEs un elemento que representa una región de texto enriquecido.
TextAlignmentEs una enumeración del tipo de alineaciones de texto.
UnsupportedElementEs un elemento que representa una región desconocida o que no puede verse afectada por una secuencia de comandos, como un número de página.
VerticalAlignmentEs una enumeración de los tipos de alineación vertical admitidos.

Attribute

Propiedades

PropiedadTipoDescripción
BACKGROUND_COLOREnumEs el color de fondo de un elemento (párrafo, tabla, etcétera) o documento.
BOLDEnumEs el parámetro de configuración del peso de la fuente para el texto enriquecido.
BORDER_COLOREnumColor del borde para los elementos de la tabla.
BORDER_WIDTHEnumEs el ancho del borde en puntos para los elementos de la tabla.
CODEEnumContenido del código, para los elementos de ecuación.
FONT_FAMILYEnumEs el parámetro de configuración de la familia de fuentes para el texto enriquecido.
FONT_SIZEEnumEs el parámetro de configuración del tamaño de fuente en puntos para el texto enriquecido.
FOREGROUND_COLOREnumEs el parámetro de configuración del color de primer plano para el texto enriquecido.
HEADINGEnumEs el tipo de encabezado, para elementos de párrafo (por ejemplo, DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumEs el parámetro de configuración de altura para los elementos de imagen.
HORIZONTAL_ALIGNMENTEnumEs la alineación horizontal para los elementos de párrafo (por ejemplo, DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumEs el parámetro de configuración de sangría final en puntos para los elementos de párrafo.
INDENT_FIRST_LINEEnumEs el parámetro de configuración de sangría de la primera línea en puntos para los elementos de párrafo.
INDENT_STARTEnumEs el parámetro de configuración de sangría inicial en puntos para los elementos de párrafo.
ITALICEnumEs el parámetro de configuración del estilo de fuente para el texto enriquecido.
GLYPH_TYPEEnumEs el tipo de glifo para los elementos de la lista.
LEFT_TO_RIGHTEnumEs el parámetro de configuración de la dirección del texto, para texto enriquecido.
LINE_SPACINGEnumEs el parámetro de configuración del espaciado entre líneas como multiplicador para los elementos de párrafo.
LINK_URLEnumEs la URL del vínculo, para texto enriquecido.
LIST_IDEnumEs el ID de la lista que abarca los elementos de la lista.
MARGIN_BOTTOMEnumEs el parámetro de configuración del margen inferior en puntos para los elementos de párrafo.
MARGIN_LEFTEnumEs el parámetro de configuración del margen izquierdo en puntos para los elementos de párrafo.
MARGIN_RIGHTEnumEs el parámetro de configuración del margen derecho en puntos para los elementos de párrafo.
MARGIN_TOPEnumEs el parámetro de configuración del margen superior en puntos para los elementos de párrafo.
NESTING_LEVELEnumEs el nivel de anidamiento del elemento, para los elementos de la lista.
MINIMUM_HEIGHTEnumEs el parámetro de configuración de altura mínima en puntos para los elementos de fila de la tabla.
PADDING_BOTTOMEnumEs el parámetro de configuración del padding inferior en puntos para los elementos de celdas de la tabla.
PADDING_LEFTEnumEs el parámetro de configuración del padding izquierdo en puntos para los elementos de celdas de la tabla.
PADDING_RIGHTEnumEs el parámetro de configuración del padding derecho en puntos para los elementos de celdas de la tabla.
PADDING_TOPEnumEs el parámetro de configuración del padding superior en puntos para los elementos de celdas de la tabla.
PAGE_HEIGHTEnumEs el parámetro de configuración de la altura de la página en puntos para los documentos.
PAGE_WIDTHEnumEs el parámetro de configuración del ancho de la página en puntos para los documentos.
SPACING_AFTEREnumEs el parámetro de configuración de espaciado inferior en puntos para los elementos de párrafo.
SPACING_BEFOREEnumEs el parámetro de configuración de espaciado superior en puntos para los elementos de párrafo.
STRIKETHROUGHEnumEs el parámetro de configuración de tachado para texto enriquecido.
UNDERLINEEnumEs el parámetro de configuración de subrayado para texto enriquecido.
VERTICAL_ALIGNMENTEnumEs el parámetro de configuración de alineación vertical para los elementos de celda de tabla.
WIDTHEnumEs el parámetro de configuración de ancho para los elementos de celdas de tablas y de imágenes.

Body

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendHorizontalRule()HorizontalRuleCrea y agrega un nuevo HorizontalRule.
appendImage(image)InlineImageCrea y agrega un nuevo InlineImage a partir del blob de imagen especificado.
appendImage(image)InlineImageAgrega el InlineImage determinado.
appendListItem(listItem)ListItemAgrega el ListItem determinado.
appendListItem(text)ListItemCrea y agrega un nuevo ListItem que contiene el contenido de texto especificado.
appendPageBreak()PageBreakCrea y agrega un nuevo PageBreak.
appendPageBreak(pageBreak)PageBreakAgrega el PageBreak determinado.
appendParagraph(paragraph)ParagraphAgrega el Paragraph determinado.
appendParagraph(text)ParagraphCrea y agrega un nuevo Paragraph que contiene el contenido de texto especificado.
appendTable()TableCrea y agrega un nuevo Table.
appendTable(cells)TableAnexa un nuevo Table que contiene un TableCell para cada valor de cadena especificado.
appendTable(table)TableAgrega el Table determinado.
clear()BodyBorra el contenido del elemento.
copy()BodyDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getHeadingAttributes(paragraphHeading)ObjectRecupera el conjunto de atributos para el ParagraphHeading proporcionado.
getImages()InlineImage[]|nullRecupera todos los InlineImages incluidos en la sección.
getListItems()ListItem[]|nullRecupera todos los ListItems incluidos en la sección.
getMarginBottom()Number|nullRecupera el margen inferior, en puntos.
getMarginLeft()Number|nullRecupera el margen izquierdo, en puntos.
getMarginRight()Number|nullRecupera el margen derecho.
getMarginTop()Number|nullRecupera el margen superior.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getPageHeight()Number|nullRecupera la altura de la página, en puntos.
getPageWidth()Number|nullRecupera el ancho de la página, en puntos.
getParagraphs()Paragraph[]|nullRecupera todos los Paragraphs incluidos en la sección (incluido ListItems).
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getTables()Table[]|nullRecupera todos los Tables incluidos en la sección.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserta un nuevo HorizontalRule en el índice especificado.
insertImage(childIndex, image)InlineImageCrea e inserta un InlineImage a partir del blob de imagen especificado en el índice especificado.
insertImage(childIndex, image)InlineImageInserta el InlineImage proporcionado en el índice especificado.
insertListItem(childIndex, listItem)ListItemInserta el ListItem proporcionado en el índice especificado.
insertListItem(childIndex, text)ListItemCrea e inserta un nuevo ListItem en el índice especificado, que contiene el contenido de texto especificado.
insertPageBreak(childIndex)PageBreakCrea e inserta un nuevo PageBreak en el índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInserta el PageBreak proporcionado en el índice especificado.
insertParagraph(childIndex, paragraph)ParagraphInserta el Paragraph proporcionado en el índice especificado.
insertParagraph(childIndex, text)ParagraphCrea e inserta un nuevo Paragraph en el índice especificado, que contiene el contenido de texto especificado.
insertTable(childIndex)TableCrea e inserta un nuevo Table en el índice especificado.
insertTable(childIndex, cells)TableCrea e inserta un nuevo Table que contiene las celdas especificadas en el índice especificado.
insertTable(childIndex, table)TableInserta el Table proporcionado en el índice especificado.
removeChild(child)BodyQuita el elemento secundario especificado.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)BodyEstablece los atributos del elemento.
setHeadingAttributes(paragraphHeading, attributes)BodyEstablece los atributos para el ParagraphHeading proporcionado.
setMarginBottom(marginBottom)BodyEstablece el margen inferior, en puntos.
setMarginLeft(marginLeft)BodyEstablece el margen izquierdo, en puntos.
setMarginRight(marginRight)BodyEstablece el margen derecho, en puntos.
setMarginTop(marginTop)BodyEstablece el margen superior.
setPageHeight(pageHeight)BodyEstablece la altura de la página en puntos.
setPageWidth(pageWidth)BodyEstablece el ancho de la página en puntos.
setText(text)BodyEstablece el contenido como texto sin formato.
setTextAlignment(textAlignment)BodyEstablece la alineación del texto.

Bookmark

Métodos

MétodoTipo de datos que se muestraDescripción breve
getId()StringObtiene el ID del Bookmark.
getPosition()PositionObtiene el Position del Bookmark dentro del DocumentTab.
remove()voidBorra el Bookmark.

ContainerElement

Métodos

MétodoTipo de datos que se muestraDescripción breve
asBody()BodyDevuelve el elemento actual como un Body.
asEquation()EquationDevuelve el elemento actual como un Equation.
asFooterSection()FooterSectionDevuelve el elemento actual como un FooterSection.
asFootnoteSection()FootnoteSectionDevuelve el elemento actual como un FootnoteSection.
asHeaderSection()HeaderSectionDevuelve el elemento actual como un HeaderSection.
asListItem()ListItemDevuelve el elemento actual como un ListItem.
asParagraph()ParagraphDevuelve el elemento actual como un Paragraph.
asTable()TableDevuelve el elemento actual como un Table.
asTableCell()TableCellDevuelve el elemento actual como un TableCell.
asTableOfContents()TableOfContentsDevuelve el elemento actual como un TableOfContents.
asTableRow()TableRowDevuelve el elemento actual como un TableRow.
clear()ContainerElementBorra el contenido del elemento.
copy()ContainerElementDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getLinkUrl()String|nullRecupera la URL del vínculo.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()ContainerElement|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()ContainerElement|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)ContainerElementEstablece los atributos del elemento.
setLinkUrl(url)ContainerElementEstablece la URL del vínculo.
setTextAlignment(textAlignment)ContainerElementEstablece la alineación del texto.

Date

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()DateDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
getDisplayText()StringDevuelve el valor de visualización que se renderiza en el documento.
getLocale()StringDevuelve la configuración regional de la fecha que se usa para el valor de visualización.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getTimestamp()DateDevuelve la marca de tiempo asociada a la fecha.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()Date|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()Date|nullQuita el elemento de su elemento superior.
setAttributes(attributes)DateEstablece los atributos del elemento.

Document

Métodos

MétodoTipo de datos que se muestraDescripción breve
addBookmark(position)BookmarkAgrega un Bookmark en el Position determinado a la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, a la pestaña activa.
addEditor(emailAddress)DocumentAgrega el usuario especificado a la lista de editores del Document.
addEditor(user)DocumentAgrega el usuario especificado a la lista de editores del Document.
addEditors(emailAddresses)DocumentAgrega el array de usuarios proporcionado a la lista de editores del Document.
addFooter()FooterSectionAgrega una sección de pie de página, si no existe, a la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, a la pestaña activa.
addHeader()HeaderSectionAgrega una sección de encabezado, si no existe, a la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, a la pestaña activa.
addNamedRange(name, range)NamedRangeAgrega un NamedRange, que es un Range que tiene un nombre y un ID para usar en la recuperación posterior, en la primera pestaña o, para las secuencias de comandos que están vinculadas a un documento, en la pestaña activa.
addViewer(emailAddress)DocumentAgrega el usuario determinado a la lista de usuarios que pueden ver el Document.
addViewer(user)DocumentAgrega el usuario determinado a la lista de usuarios que pueden ver el Document.
addViewers(emailAddresses)DocumentAgrega el array de usuarios proporcionado a la lista de usuarios que pueden ver el Document.
getActiveTab()TabObtiene el Tab activo del usuario en el documento.
getAs(contentType)BlobRecupera el contenido actual de Document como un BLOB del tipo especificado.
getBlob()BlobRecupera el contenido actual de Document como un BLOB.
getBody()BodyRecupera el Body de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, el DocumentBodySection de la pestaña activa.
getBookmark(id)Bookmark|nullObtiene el objeto Bookmark con el ID determinado en la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la pestaña activa.
getBookmarks()Bookmark[]Obtiene todos los objetos Bookmark de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa.
getCursor()Position|nullObtiene el cursor del usuario en la pestaña activa.
getEditors()User[]Obtiene la lista de editores de este Document.
getFooter()FooterSection|nullRecupera la sección de pie de página de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la sección de pie de página de la pestaña activa.
getFootnotes()Footnote[]|nullRecupera todos los elementos Footnote del cuerpo de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, del cuerpo de la pestaña activa.
getHeader()HeaderSection|nullRecupera la sección de encabezado de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la sección de encabezado de la pestaña activa.
getId()StringRecupera el identificador único del documento.
getLanguage()StringObtiene el código de idioma del documento.
getName()StringRecupera el título del documento.
getNamedRangeById(id)NamedRange|nullObtiene el objeto NamedRange con el ID determinado en la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la pestaña activa.
getNamedRanges()NamedRange[]Obtiene todos los objetos NamedRange de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa.
getNamedRanges(name)NamedRange[]Obtiene todos los objetos NamedRange con el nombre determinado en la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa.
getSelection()Range|nullObtiene la selección del usuario en la pestaña activa.
getSupportedLanguageCodes()String[]Obtiene todos los códigos de idioma que se admiten en los archivos de Documentos de Google.
getTab(tabId)TabObtiene el Tab con el ID especificado.
getTabs()Tab[]Obtiene todos los Tab no anidados que forman parte del documento.
getUrl()StringRecupera la URL para acceder al documento actual.
getViewers()User[]Obtiene la lista de lectores y comentaristas de este Document.
newPosition(element, offset)PositionCrea un nuevo Position, que es una referencia a una ubicación en la pestaña, en relación con un elemento específico de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la pestaña activa.
newRange()RangeBuilderCrea un compilador que se usa para construir objetos Range a partir de elementos de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa.
removeEditor(emailAddress)DocumentQuita al usuario especificado de la lista de editores del Document.
removeEditor(user)DocumentQuita al usuario especificado de la lista de editores del Document.
removeViewer(emailAddress)DocumentQuita al usuario determinado de la lista de usuarios que pueden ver y comentar el Document.
removeViewer(user)DocumentQuita al usuario determinado de la lista de usuarios que pueden ver y comentar el Document.
saveAndClose()voidGuarda el Document actual.
setActiveTab(tabId)voidEstablece el Tab seleccionado por el usuario en el documento actual en la pestaña con el ID especificado.
setCursor(position)DocumentEstablece el cursor del usuario, dado un Position.
setLanguage(languageCode)DocumentEstablece el código de idioma del documento.
setName(name)DocumentEstablece el título del documento.
setSelection(range)DocumentEstablece la selección del usuario en la pestaña activa, dado un Range.

DocumentApp

Propiedades

PropiedadTipoDescripción
AttributeAttributeEs la enumeración Attribute.
ElementTypeElementTypeEs la enumeración ElementType.
FontFamilyFontFamilyEs la enumeración FontFamily.
GlyphTypeGlyphTypeEs la enumeración GlyphType.
HorizontalAlignmentHorizontalAlignmentEs la enumeración HorizontalAlignment.
ParagraphHeadingParagraphHeadingEs la enumeración ParagraphHeading.
PositionedLayoutPositionedLayoutEs la enumeración PositionedLayout.
TextAlignmentTextAlignmentEs la enumeración TextAlignment.
VerticalAlignmentVerticalAlignmentEs la enumeración VerticalAlignment.

Métodos

MétodoTipo de datos que se muestraDescripción breve
create(name)DocumentCrea y devuelve un documento nuevo.
getActiveDocument()DocumentDevuelve el documento al que está vinculada la secuencia de comandos.
getUi()UiDevuelve una instancia del entorno de la interfaz de usuario del documento que permite que la secuencia de comandos agregue funciones como menús, diálogos y barras laterales.
openById(id)DocumentDevuelve el documento con el ID especificado.
openByUrl(url)DocumentAbre y devuelve el documento con la URL especificada.

DocumentTab

Métodos

MétodoTipo de datos que se muestraDescripción breve
addBookmark(position)BookmarkAgrega un Bookmark en el Position determinado.
addFooter()FooterSectionAgrega una sección de pie de página de la pestaña, si no existe ninguna.
addHeader()HeaderSectionAgrega una sección de encabezado de pestaña, si no existe ninguna.
addNamedRange(name, range)NamedRangeAgrega un NamedRange, que es un Range que tiene un nombre y un ID para usar en la recuperación posterior.
getBody()BodyRecupera el Body de la pestaña.
getBookmark(id)Bookmark|nullObtiene el Bookmark con el ID determinado.
getBookmarks()Bookmark[]Obtiene todos los objetos Bookmark de la pestaña.
getFooter()FooterSection|nullRecupera la sección de pie de página de la pestaña, si existe.
getFootnotes()Footnote[]|nullRecupera todos los elementos Footnote del cuerpo de la pestaña.
getHeader()HeaderSection|nullRecupera la sección de encabezado de la pestaña, si existe.
getNamedRangeById(id)NamedRange|nullObtiene el NamedRange con el ID determinado.
getNamedRanges()NamedRange[]Obtiene todos los objetos NamedRange de la pestaña.
getNamedRanges(name)NamedRange[]Obtiene todos los objetos NamedRange de la pestaña con el nombre determinado.
newPosition(element, offset)PositionCrea un Position nuevo, que es una referencia a una ubicación en la pestaña, en relación con un elemento específico.
newRange()RangeBuilderCrea un compilador que se usa para construir objetos Range a partir de elementos de pestañas.

Element

Métodos

MétodoTipo de datos que se muestraDescripción breve
asBody()BodyDevuelve el elemento actual como un Body.
asDate()DateDevuelve el elemento actual como un Date.
asEquation()EquationDevuelve el elemento actual como un Equation.
asEquationFunction()EquationFunctionDevuelve el elemento actual como un EquationFunction.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorDevuelve el elemento actual como un EquationFunctionArgumentSeparator.
asEquationSymbol()EquationSymbolDevuelve el elemento actual como un EquationSymbol.
asFooterSection()FooterSectionDevuelve el elemento actual como un FooterSection.
asFootnote()FootnoteDevuelve el elemento actual como un Footnote.
asFootnoteSection()FootnoteSectionDevuelve el elemento actual como un FootnoteSection.
asHeaderSection()HeaderSectionDevuelve el elemento actual como un HeaderSection.
asHorizontalRule()HorizontalRuleDevuelve el elemento actual como un HorizontalRule.
asInlineDrawing()InlineDrawingDevuelve el elemento actual como un InlineDrawing.
asInlineImage()InlineImageDevuelve el elemento actual como un InlineImage.
asListItem()ListItemDevuelve el elemento actual como un ListItem.
asPageBreak()PageBreakDevuelve el elemento actual como un PageBreak.
asParagraph()ParagraphDevuelve el elemento actual como un Paragraph.
asPerson()PersonDevuelve el elemento actual como un Person.
asRichLink()RichLinkDevuelve el elemento actual como un RichLink, por ejemplo, un vínculo a un archivo de Hojas de cálculo de Google.
asTable()TableDevuelve el elemento actual como un Table.
asTableCell()TableCellDevuelve el elemento actual como un TableCell.
asTableOfContents()TableOfContentsDevuelve el elemento actual como un TableOfContents.
asTableRow()TableRowDevuelve el elemento actual como un TableRow.
asText()TextDevuelve el elemento actual como un Text.
copy()ElementDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()Element|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()Element|nullQuita el elemento de su elemento superior.
setAttributes(attributes)ElementEstablece los atributos del elemento.

ElementType

Propiedades

PropiedadTipoDescripción
BODY_SECTIONEnumEs el tipo correspondiente al elemento Body.
COMMENT_SECTIONEnumEs el tipo correspondiente al elemento CommentSection.
DATEEnumEs el tipo correspondiente al elemento Date.
EQUATIONEnumEs el tipo correspondiente al elemento Equation.
EQUATION_FUNCTIONEnumEs el tipo correspondiente al elemento EquationFunction.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumEs el tipo correspondiente al elemento EquationFunctionArgumentSeparator.
EQUATION_SYMBOLEnumEs el tipo correspondiente al elemento EquationSymbol.
RICH_LINKEnumEs el tipo correspondiente al elemento RichLink.
FOOTER_SECTIONEnumEs el tipo correspondiente al elemento FooterSection.
FOOTNOTEEnumEs el tipo correspondiente al elemento Footnote.
FOOTNOTE_SECTIONEnumEs el tipo correspondiente al elemento FootnoteSection.
HEADER_SECTIONEnumEs el tipo correspondiente al elemento HeaderSection.
HORIZONTAL_RULEEnumEs el tipo correspondiente al elemento HorizontalRule.
INLINE_DRAWINGEnumEs el tipo correspondiente al elemento InlineDrawing.
INLINE_IMAGEEnumEs el tipo correspondiente al elemento InlineImage.
LIST_ITEMEnumEs el tipo correspondiente al elemento ListItem.
PAGE_BREAKEnumEs el tipo correspondiente al elemento PageBreak.
PARAGRAPHEnumEs el tipo correspondiente al elemento Paragraph.
PERSONEnumEs el tipo correspondiente al elemento Person.
TABLEEnumEs el tipo correspondiente al elemento Table.
TABLE_CELLEnumEs el tipo correspondiente al elemento TableCell.
TABLE_OF_CONTENTSEnumEs el tipo correspondiente al elemento TableOfContents.
TABLE_ROWEnumEs el tipo correspondiente al elemento TableRow.
TEXTEnumEs el tipo correspondiente al elemento Text.
UNSUPPORTEDEnumEs el tipo correspondiente a UnsupportedElement.

Equation

Métodos

MétodoTipo de datos que se muestraDescripción breve
clear()EquationBorra el contenido del elemento.
copy()EquationDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getLinkUrl()String|nullRecupera la URL del vínculo.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()Equation|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()Equation|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)EquationEstablece los atributos del elemento.
setLinkUrl(url)EquationEstablece la URL del vínculo.
setTextAlignment(textAlignment)EquationEstablece la alineación del texto.

EquationFunction

Métodos

MétodoTipo de datos que se muestraDescripción breve
clear()EquationFunctionBorra el contenido del elemento.
copy()EquationFunctionDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getCode()StringRecupera el código correspondiente a la función de ecuación.
getLinkUrl()String|nullRecupera la URL del vínculo.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()EquationFunction|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()EquationFunction|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)EquationFunctionEstablece los atributos del elemento.
setLinkUrl(url)EquationFunctionEstablece la URL del vínculo.
setTextAlignment(textAlignment)EquationFunctionEstablece la alineación del texto.

EquationFunctionArgumentSeparator

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()EquationFunctionArgumentSeparatorDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()EquationFunctionArgumentSeparator|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()EquationFunctionArgumentSeparator|nullQuita el elemento de su elemento superior.
setAttributes(attributes)EquationFunctionArgumentSeparatorEstablece los atributos del elemento.

EquationSymbol

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()EquationSymbolDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
getCode()StringRecupera el código correspondiente al símbolo de ecuación.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()EquationSymbol|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()EquationSymbol|nullQuita el elemento de su elemento superior.
setAttributes(attributes)EquationSymbolEstablece los atributos del elemento.

FontFamily

FooterSection

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendHorizontalRule()HorizontalRuleCrea y agrega un nuevo HorizontalRule.
appendImage(image)InlineImageCrea y agrega un nuevo InlineImage a partir del blob de imagen especificado.
appendImage(image)InlineImageAgrega el InlineImage determinado.
appendListItem(listItem)ListItemAgrega el ListItem determinado.
appendListItem(text)ListItemCrea y agrega un nuevo ListItem que contiene el contenido de texto especificado.
appendParagraph(paragraph)ParagraphAgrega el Paragraph determinado.
appendParagraph(text)ParagraphCrea y agrega un nuevo Paragraph que contiene el contenido de texto especificado.
appendTable()TableCrea y agrega un nuevo Table.
appendTable(cells)TableAnexa un nuevo Table que contiene un TableCell para cada valor de cadena especificado.
appendTable(table)TableAgrega el Table determinado.
clear()FooterSectionBorra el contenido del elemento.
copy()FooterSectionDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getImages()InlineImage[]|nullRecupera todos los InlineImages incluidos en la sección.
getListItems()ListItem[]|nullRecupera todos los ListItems incluidos en la sección.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParagraphs()Paragraph[]|nullRecupera todos los Paragraphs incluidos en la sección (incluido ListItems).
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getTables()Table[]|nullRecupera todos los Tables incluidos en la sección.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserta un nuevo HorizontalRule en el índice especificado.
insertImage(childIndex, image)InlineImageCrea e inserta un InlineImage a partir del blob de imagen especificado en el índice especificado.
insertImage(childIndex, image)InlineImageInserta el InlineImage proporcionado en el índice especificado.
insertListItem(childIndex, listItem)ListItemInserta el ListItem proporcionado en el índice especificado.
insertListItem(childIndex, text)ListItemCrea e inserta un nuevo ListItem en el índice especificado, que contiene el contenido de texto especificado.
insertParagraph(childIndex, paragraph)ParagraphInserta el Paragraph proporcionado en el índice especificado.
insertParagraph(childIndex, text)ParagraphCrea e inserta un nuevo Paragraph en el índice especificado, que contiene el contenido de texto especificado.
insertTable(childIndex)TableCrea e inserta un nuevo Table en el índice especificado.
insertTable(childIndex, cells)TableCrea e inserta un nuevo Table que contiene las celdas especificadas en el índice especificado.
insertTable(childIndex, table)TableInserta el Table proporcionado en el índice especificado.
removeChild(child)FooterSectionQuita el elemento secundario especificado.
removeFromParent()FooterSection|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)FooterSectionEstablece los atributos del elemento.
setText(text)FooterSectionEstablece el contenido como texto sin formato.
setTextAlignment(textAlignment)FooterSectionEstablece la alineación del texto.

Footnote

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()FootnoteDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
getFootnoteContents()FootnoteSection|nullRecupera el contenido del elemento de nota al pie.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
removeFromParent()Footnote|nullQuita el elemento de su elemento superior.
setAttributes(attributes)FootnoteEstablece los atributos del elemento.

FootnoteSection

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendParagraph(paragraph)ParagraphAgrega el Paragraph determinado.
appendParagraph(text)ParagraphCrea y agrega un nuevo Paragraph que contiene el contenido de texto especificado.
clear()FootnoteSectionBorra el contenido del elemento.
copy()FootnoteSectionDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParagraphs()Paragraph[]|nullRecupera todos los Paragraphs incluidos en la sección (incluido ListItems).
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertParagraph(childIndex, paragraph)ParagraphInserta el Paragraph proporcionado en el índice especificado.
insertParagraph(childIndex, text)ParagraphCrea e inserta un nuevo Paragraph en el índice especificado, que contiene el contenido de texto especificado.
removeChild(child)FootnoteSectionQuita el elemento secundario especificado.
removeFromParent()FootnoteSection|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)FootnoteSectionEstablece los atributos del elemento.
setText(text)FootnoteSectionEstablece el contenido como texto sin formato.
setTextAlignment(textAlignment)FootnoteSectionEstablece la alineación del texto.

GlyphType

Propiedades

PropiedadTipoDescripción
BULLETEnumViñeta predeterminada, circular y rellena.
HOLLOW_BULLETEnumUna bala hueca.
SQUARE_BULLETEnumEs una viñeta cuadrada.
NUMBEREnumViñeta numérica.
LATIN_UPPEREnumViñeta latina en mayúsculas.
LATIN_LOWEREnumViñeta latina en minúscula.
ROMAN_UPPEREnumEs un número romano, con viñeta en mayúsculas.
ROMAN_LOWEREnumUna viñeta en números romanos y letras minúsculas.

HeaderSection

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendHorizontalRule()HorizontalRuleCrea y agrega un nuevo HorizontalRule.
appendImage(image)InlineImageCrea y agrega un nuevo InlineImage a partir del blob de imagen especificado.
appendImage(image)InlineImageAgrega el InlineImage determinado.
appendListItem(listItem)ListItemAgrega el ListItem determinado.
appendListItem(text)ListItemCrea y agrega un nuevo ListItem que contiene el contenido de texto especificado.
appendParagraph(paragraph)ParagraphAgrega el Paragraph determinado.
appendParagraph(text)ParagraphCrea y agrega un nuevo Paragraph que contiene el contenido de texto especificado.
appendTable()TableCrea y agrega un nuevo Table.
appendTable(cells)TableAnexa un nuevo Table que contiene un TableCell para cada valor de cadena especificado.
appendTable(table)TableAgrega el Table determinado.
clear()HeaderSectionBorra el contenido del elemento.
copy()HeaderSectionDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getImages()InlineImage[]|nullRecupera todos los InlineImages incluidos en la sección.
getListItems()ListItem[]|nullRecupera todos los ListItems incluidos en la sección.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParagraphs()Paragraph[]|nullRecupera todos los Paragraphs incluidos en la sección (incluido ListItems).
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getTables()Table[]|nullRecupera todos los Tables incluidos en la sección.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserta un nuevo HorizontalRule en el índice especificado.
insertImage(childIndex, image)InlineImageCrea e inserta un InlineImage a partir del blob de imagen especificado en el índice especificado.
insertImage(childIndex, image)InlineImageInserta el InlineImage proporcionado en el índice especificado.
insertListItem(childIndex, listItem)ListItemInserta el ListItem proporcionado en el índice especificado.
insertListItem(childIndex, text)ListItemCrea e inserta un nuevo ListItem en el índice especificado, que contiene el contenido de texto especificado.
insertParagraph(childIndex, paragraph)ParagraphInserta el Paragraph proporcionado en el índice especificado.
insertParagraph(childIndex, text)ParagraphCrea e inserta un nuevo Paragraph en el índice especificado, que contiene el contenido de texto especificado.
insertTable(childIndex)TableCrea e inserta un nuevo Table en el índice especificado.
insertTable(childIndex, cells)TableCrea e inserta un nuevo Table que contiene las celdas especificadas en el índice especificado.
insertTable(childIndex, table)TableInserta el Table proporcionado en el índice especificado.
removeChild(child)HeaderSectionQuita el elemento secundario especificado.
removeFromParent()HeaderSection|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)HeaderSectionEstablece los atributos del elemento.
setText(text)HeaderSectionEstablece el contenido como texto sin formato.
setTextAlignment(textAlignment)HeaderSectionEstablece la alineación del texto.

HorizontalAlignment

Propiedades

PropiedadTipoDescripción
LEFTEnumOpción de alineación a la izquierda.
CENTEREnumOpción de alineación central.
RIGHTEnumOpción de alineación a la derecha.
JUSTIFYEnumOpción de alineación justificada.

HorizontalRule

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()HorizontalRuleDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
removeFromParent()HorizontalRule|nullQuita el elemento de su elemento superior.
setAttributes(attributes)HorizontalRuleEstablece los atributos del elemento.

InlineDrawing

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()InlineDrawingDevuelve una copia profunda y separada del elemento actual.
getAltDescription()String|nullDevuelve la descripción alternativa del dibujo.
getAltTitle()String|nullDevuelve el título alternativo del dibujo.
getAttributes()ObjectRecupera los atributos del elemento.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()InlineDrawing|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()InlineDrawing|nullQuita el elemento de su elemento superior.
setAltDescription(description)InlineDrawingEstablece la descripción alternativa del dibujo.
setAltTitle(title)InlineDrawingEstablece el título alternativo del dibujo.
setAttributes(attributes)InlineDrawingEstablece los atributos del elemento.

InlineImage

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()InlineImageDevuelve una copia profunda y separada del elemento actual.
getAltDescription()String|nullDevuelve la descripción alternativa de la imagen.
getAltTitle()String|nullDevuelve el título alternativo de la imagen.
getAs(contentType)BlobDevuelve los datos dentro de este objeto como un blob convertido al tipo de contenido especificado.
getAttributes()ObjectRecupera los atributos del elemento.
getBlob()BlobDevuelve los datos dentro de este objeto como un blob.
getHeight()IntegerRecupera la altura de la imagen en píxeles.
getLinkUrl()String|nullRecupera la URL del vínculo.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
getWidth()IntegerRecupera el ancho de la imagen en píxeles.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()InlineImage|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()InlineImage|nullQuita el elemento de su elemento superior.
setAltDescription(description)InlineImageEstablece la descripción alternativa de la imagen.
setAltTitle(title)InlineImageEstablece el título alternativo de la imagen.
setAttributes(attributes)InlineImageEstablece los atributos del elemento.
setHeight(height)InlineImageEstablece la altura de la imagen en píxeles.
setLinkUrl(url)InlineImageEstablece la URL del vínculo.
setWidth(width)InlineImageEstablece el ancho de la imagen en píxeles.

ListItem

Métodos

MétodoTipo de datos que se muestraDescripción breve
addPositionedImage(image)PositionedImageCrea e inserta un nuevo PositionedImage a partir del blob de imagen especificado.
appendHorizontalRule()HorizontalRuleCrea y agrega un nuevo HorizontalRule.
appendInlineImage(image)InlineImageCrea y agrega un nuevo InlineImage a partir del blob de imagen especificado.
appendInlineImage(image)InlineImageAgrega el InlineImage determinado.
appendPageBreak()PageBreakCrea y agrega un nuevo PageBreak.
appendPageBreak(pageBreak)PageBreakAgrega el PageBreak determinado.
appendText(text)TextCrea y agrega un nuevo elemento Text con el contenido especificado.
appendText(text)TextAnexa el elemento Text determinado.
clear()ListItemBorra el contenido del elemento.
copy()ListItemDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAlignment()HorizontalAlignment|nullRecupera el HorizontalAlignment.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getGlyphType()GlyphType|nullRecupera el GlyphType del elemento de la lista.
getHeading()ParagraphHeading|nullRecupera el ParagraphHeading.
getIndentEnd()Number|nullRecupera la sangría final, en puntos.
getIndentFirstLine()Number|nullRecupera la sangría de la primera línea, en puntos.
getIndentStart()Number|nullRecupera la sangría inicial.
getLineSpacing()Number|nullRecupera el interlineado, en puntos.
getLinkUrl()String|nullRecupera la URL del vínculo.
getListId()String|nullRecupera el ID de la lista.
getNestingLevel()IntegerRecupera el nivel de anidamiento del elemento de la lista.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPositionedImage(id)PositionedImageObtiene un PositionedImage por el ID de la imagen.
getPositionedImages()PositionedImage[]Obtiene todos los objetos PositionedImage anclados al párrafo.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getSpacingAfter()Number|nullRecupera el espaciado después del elemento, en puntos.
getSpacingBefore()Number|nullRecupera el espaciado antes del elemento, en puntos.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserta un HorizontalRule en el índice especificado.
insertInlineImage(childIndex, image)InlineImageCrea e inserta un nuevo InlineImage a partir del blob de imagen especificado en el índice especificado.
insertInlineImage(childIndex, image)InlineImageInserta el InlineImage proporcionado en el índice especificado.
insertPageBreak(childIndex)PageBreakCrea e inserta un nuevo PageBreak en el índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInserta el PageBreak proporcionado en el índice especificado.
insertText(childIndex, text)TextCrea e inserta un nuevo elemento de texto en el índice especificado.
insertText(childIndex, text)TextInserta el elemento Text determinado en el índice especificado, con el contenido de texto especificado.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
isLeftToRight()Boolean|nullRecupera el parámetro de configuración de izquierda a derecha.
merge()ListItem|nullCombina el elemento con el hermano anterior del mismo tipo.
removeChild(child)ListItemQuita el elemento secundario especificado.
removeFromParent()ListItem|nullQuita el elemento de su elemento superior.
removePositionedImage(id)BooleanQuita un PositionedImage por el ID de la imagen.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAlignment(alignment)ListItemEstablece el HorizontalAlignment.
setAttributes(attributes)ListItemEstablece los atributos del elemento.
setGlyphType(glyphType)ListItemEstablece el GlyphType del elemento de la lista.
setHeading(heading)ListItemEstablece el ParagraphHeading.
setIndentEnd(indentEnd)ListItemEstablece la sangría final, en puntos.
setIndentFirstLine(indentFirstLine)ListItemEstablece la sangría de la primera línea, en puntos.
setIndentStart(indentStart)ListItemEstablece la sangría inicial, en puntos.
setLeftToRight(leftToRight)ListItemEstablece el parámetro de configuración de izquierda a derecha.
setLineSpacing(multiplier)ListItemEstablece el interlineado como una cantidad que indica la cantidad de líneas que se usarán para el espaciado.
setLinkUrl(url)ListItemEstablece la URL del vínculo.
setListId(listItem)ListItemEstablece el ID de la lista.
setNestingLevel(nestingLevel)ListItemEstablece el nivel de anidamiento del elemento de la lista.
setSpacingAfter(spacingAfter)ListItemEstablece el espaciado después del elemento, en puntos.
setSpacingBefore(spacingBefore)ListItemEstablece el espaciado antes del elemento, en puntos.
setText(text)voidEstablece el contenido del elemento de lista como texto.
setTextAlignment(textAlignment)ListItemEstablece la alineación del texto.

NamedRange

Métodos

MétodoTipo de datos que se muestraDescripción breve
getId()StringObtiene el ID de este NamedRange.
getName()StringObtiene el nombre de este NamedRange.
getRange()RangeObtiene el rango de elementos asociados con este NamedRange.
remove()voidQuita este NamedRange de la pestaña.

PageBreak

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()PageBreakDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
removeFromParent()PageBreak|nullQuita el elemento de su elemento superior.
setAttributes(attributes)PageBreakEstablece los atributos del elemento.

Paragraph

Métodos

MétodoTipo de datos que se muestraDescripción breve
addPositionedImage(image)PositionedImageCrea e inserta un nuevo PositionedImage a partir del blob de imagen especificado.
appendHorizontalRule()HorizontalRuleCrea y agrega un nuevo HorizontalRule.
appendInlineImage(image)InlineImageCrea y agrega un nuevo InlineImage a partir del blob de imagen especificado.
appendInlineImage(image)InlineImageAgrega el InlineImage determinado.
appendPageBreak()PageBreakCrea y agrega un nuevo PageBreak.
appendPageBreak(pageBreak)PageBreakAgrega el PageBreak determinado.
appendText(text)TextCrea y agrega un nuevo elemento Text con el contenido especificado.
appendText(text)TextAnexa el elemento Text determinado.
clear()ParagraphBorra el contenido del elemento.
copy()ParagraphDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAlignment()HorizontalAlignment|nullRecupera el HorizontalAlignment.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getHeading()ParagraphHeading|nullRecupera el ParagraphHeading.
getIndentEnd()Number|nullRecupera la sangría final, en puntos.
getIndentFirstLine()Number|nullRecupera la sangría de la primera línea, en puntos.
getIndentStart()Number|nullRecupera la sangría inicial.
getLineSpacing()Number|nullRecupera el interlineado, en puntos.
getLinkUrl()String|nullRecupera la URL del vínculo.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPositionedImage(id)PositionedImageObtiene un PositionedImage por el ID de la imagen.
getPositionedImages()PositionedImage[]Obtiene todos los objetos PositionedImage anclados al párrafo.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getSpacingAfter()Number|nullRecupera el espaciado después del elemento, en puntos.
getSpacingBefore()Number|nullRecupera el espaciado antes del elemento, en puntos.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserta un HorizontalRule en el índice especificado.
insertInlineImage(childIndex, image)InlineImageCrea e inserta un nuevo InlineImage a partir del blob de imagen especificado en el índice especificado.
insertInlineImage(childIndex, image)InlineImageInserta el InlineImage proporcionado en el índice especificado.
insertPageBreak(childIndex)PageBreakCrea e inserta un nuevo PageBreak en el índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInserta el PageBreak proporcionado en el índice especificado.
insertText(childIndex, text)TextCrea e inserta un nuevo elemento de texto en el índice especificado.
insertText(childIndex, text)TextInserta el elemento Text determinado en el índice especificado, con el contenido de texto especificado.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
isLeftToRight()Boolean|nullRecupera el parámetro de configuración de izquierda a derecha.
merge()Paragraph|nullCombina el elemento con el hermano anterior del mismo tipo.
removeChild(child)ParagraphQuita el elemento secundario especificado.
removeFromParent()Paragraph|nullQuita el elemento de su elemento superior.
removePositionedImage(id)BooleanQuita un PositionedImage por el ID de la imagen.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAlignment(alignment)ParagraphEstablece el HorizontalAlignment.
setAttributes(attributes)ParagraphEstablece los atributos del elemento.
setHeading(heading)ParagraphEstablece el ParagraphHeading.
setIndentEnd(indentEnd)ParagraphEstablece la sangría final, en puntos.
setIndentFirstLine(indentFirstLine)ParagraphEstablece la sangría de la primera línea, en puntos.
setIndentStart(indentStart)ParagraphEstablece la sangría inicial, en puntos.
setLeftToRight(leftToRight)ParagraphEstablece el parámetro de configuración de izquierda a derecha.
setLineSpacing(multiplier)ParagraphEstablece el interlineado como una cantidad que indica la cantidad de líneas que se usarán para el espaciado.
setLinkUrl(url)ParagraphEstablece la URL del vínculo.
setSpacingAfter(spacingAfter)ParagraphEstablece el espaciado después del elemento, en puntos.
setSpacingBefore(spacingBefore)ParagraphEstablece el espaciado antes del elemento, en puntos.
setText(text)voidEstablece el contenido del párrafo como texto.
setTextAlignment(textAlignment)ParagraphEstablece la alineación del texto.

ParagraphHeading

Propiedades

PropiedadTipoDescripción
NORMALEnumEs la opción de encabezado para el texto normal.
HEADING1EnumEs la opción de encabezado más alta.
HEADING2EnumEs la segunda opción de encabezado.
HEADING3EnumLa tercera opción de encabezado
HEADING4EnumEs la cuarta opción de encabezado.
HEADING5EnumQuinta opción de encabezado.
HEADING6EnumEs la opción de encabezado más baja.
TITLEEnumEs la opción de encabezado del título.
SUBTITLEEnumEs la opción de encabezado del subtítulo.

Person

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()PersonDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
getEmail()StringDevuelve la dirección de correo electrónico de la persona.
getName()String|nullDevuelve el nombre visible de la persona, si se configuró.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()Person|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()Person|nullQuita el elemento de su elemento superior.
setAttributes(attributes)PersonEstablece los atributos del elemento.

Position

Métodos

MétodoTipo de datos que se muestraDescripción breve
getElement()ElementObtiene el elemento que contiene este Position.
getOffset()IntegerObtiene la ubicación relativa de este Position dentro del elemento que lo contiene.
getSurroundingText()TextCrea un elemento Text artificial que representa el texto y el formato del Paragraph o ListItem que contiene el Position, ya sea directamente o a través de una cadena de elementos secundarios.
getSurroundingTextOffset()IntegerObtiene el desplazamiento de este Position dentro del elemento Text que devuelve getSurroundingText().
insertBookmark()BookmarkCrea e inserta un nuevo Bookmark en este Position.
insertInlineImage(image)InlineImage|nullCrea e inserta un nuevo InlineImage en este Position a partir del blob de imagen especificado.
insertText(text)Text|nullInserta el texto especificado en este Position.

PositionedImage

Métodos

MétodoTipo de datos que se muestraDescripción breve
getAs(contentType)BlobDevuelve los datos dentro de este objeto como un blob convertido al tipo de contenido especificado.
getBlob()BlobDevuelve los datos dentro de este objeto como un blob.
getHeight()IntegerRecupera la altura de la imagen en píxeles.
getId()StringObtiene el ID de la imagen.
getLayout()PositionedLayoutObtiene un valor de enumeración que representa cómo se dispone la imagen.
getLeftOffset()NumberObtiene el desplazamiento de la imagen, en puntos, desde la izquierda del párrafo.
getParagraph()ParagraphObtiene el Paragraph al que está anclada la imagen.
getTopOffset()NumberObtiene la compensación de la imagen, en puntos, desde la parte superior del párrafo.
getWidth()IntegerRecupera el ancho de la imagen en píxeles.
setHeight(height)PositionedImageEstablece la altura de la imagen en píxeles.
setLayout(layout)PositionedImageEstablece la definición de cómo se diseña la imagen.
setLeftOffset(offset)PositionedImageEstablece el desplazamiento de la imagen, en puntos, desde la izquierda del párrafo.
setTopOffset(offset)PositionedImageEstablece el desplazamiento de la imagen, en puntos, desde la parte superior del párrafo.
setWidth(width)PositionedImageEstablece el ancho de la imagen en píxeles.

PositionedLayout

Propiedades

PropiedadTipoDescripción
ABOVE_TEXTEnumLa imagen se posiciona sobre el texto.
BREAK_BOTHEnumLa imagen interrumpe el texto a la izquierda y a la derecha.
BREAK_LEFTEnumLa imagen interrumpe el texto de la izquierda.
BREAK_RIGHTEnumLa imagen interrumpe el texto a la derecha.
WRAP_TEXTEnumLa imagen está envuelta en texto.

Range

Métodos

MétodoTipo de datos que se muestraDescripción breve
getRangeElements()RangeElement[]Obtiene todos los elementos de este Range, incluidos los elementos Text parciales (por ejemplo, en el caso de una selección que incluye solo parte de un elemento Text).

RangeBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
addElement(element)RangeBuilderAgrega un Element completo a este RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderAgrega un elemento Text parcial a este RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAgrega dos elementos completos y todos los elementos que se encuentran entre ellos a este RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAgrega dos elementos Text parciales y todos los elementos que se encuentran entre ellos al RangeBuilder.
addRange(range)RangeBuilderAgrega el contenido de otro Range a este RangeBuilder.
build()RangeConstruye un objeto Range a partir de la configuración aplicada al compilador.
getRangeElements()RangeElement[]Obtiene todos los elementos de este Range, incluidos los elementos Text parciales (por ejemplo, en el caso de una selección que incluye solo parte de un elemento Text).

RangeElement

Métodos

MétodoTipo de datos que se muestraDescripción breve
getElement()ElementObtiene el Element que corresponde a este RangeElement.
getEndOffsetInclusive()IntegerObtiene la posición del final de un rango parcial dentro del elemento de rango.
getStartOffset()IntegerObtiene la posición del inicio de un rango parcial dentro del elemento de rango.
isPartial()BooleanDetermina si este elemento de rango abarca todo el elemento o una selección parcial de los caracteres del elemento.

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()RichLinkDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
getMimeType()String|nullDevuelve el tipo de MIME del vínculo, que está disponible cuando el elemento es un vínculo a un archivo de Drive y null en otros casos.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getTitle()StringDevuelve el título que se muestra del vínculo.
getType()ElementTypeRecupera el ElementType del elemento.
getUrl()StringDevuelve la URL del recurso.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()RichLink|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()RichLink|nullQuita el elemento de su elemento superior.
setAttributes(attributes)RichLinkEstablece los atributos del elemento.

Tab

Métodos

MétodoTipo de datos que se muestraDescripción breve
asDocumentTab()DocumentTabRecupera el contenido de la pestaña como un DocumentTab.
getChildTabs()Tab[]Recupera las pestañas secundarias anidadas dentro de esta pestaña.
getId()StringRecupera el ID de la pestaña.
getIndex()IntegerRecupera el índice basado en 0 de la pestaña dentro del elemento principal.
getTitle()StringRecupera el título de la pestaña.
getType()TabTypeRecupera el tipo de pestaña.

TabType

Propiedades

PropiedadTipoDescripción
DOCUMENT_TABEnumEs el tipo correspondiente a DocumentTab.

Table

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendTableRow()TableRowCrea y agrega un nuevo TableRow.
appendTableRow(tableRow)TableRowAgrega el TableRow determinado.
clear()TableBorra el contenido del elemento.
copy()TableDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getBorderColor()String|nullRecupera el color del borde.
getBorderWidth()Number|nullRecupera el ancho del borde, en puntos.
getCell(rowIndex, cellIndex)TableCell|nullRecupera el TableCell en los índices de fila y celda especificados.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getColumnWidth(columnIndex)Number|nullRecupera el ancho de la columna de la tabla especificada, en puntos.
getLinkUrl()String|nullRecupera la URL del vínculo.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getNumRows()IntegerRecupera la cantidad de TableRows.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getRow(rowIndex)TableRow|nullRecupera el TableRow en el índice de fila especificado.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertTableRow(childIndex)TableRowCrea e inserta un nuevo TableRow en el índice especificado.
insertTableRow(childIndex, tableRow)TableRowInserta el TableRow proporcionado en el índice especificado.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
removeChild(child)TableQuita el elemento secundario especificado.
removeFromParent()Table|nullQuita el elemento de su elemento superior.
removeRow(rowIndex)TableRowQuita el TableRow en el índice de fila especificado.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)TableEstablece los atributos del elemento.
setBorderColor(color)TableEstablece el color del borde.
setBorderWidth(width)TableEstablece el ancho del borde en puntos.
setColumnWidth(columnIndex, width)TableEstablece el ancho de la columna especificada, en puntos.
setLinkUrl(url)TableEstablece la URL del vínculo.
setTextAlignment(textAlignment)TableEstablece la alineación del texto.

TableCell

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendHorizontalRule()HorizontalRuleCrea y agrega un nuevo HorizontalRule.
appendImage(image)InlineImageCrea y agrega un nuevo InlineImage a partir del blob de imagen especificado.
appendImage(image)InlineImageAgrega el InlineImage determinado.
appendListItem(listItem)ListItemAgrega el ListItem determinado.
appendListItem(text)ListItemCrea y agrega un nuevo ListItem.
appendParagraph(paragraph)ParagraphAgrega el Paragraph determinado.
appendParagraph(text)ParagraphCrea y agrega un nuevo Paragraph.
appendTable()TableCrea y agrega un nuevo Table.
appendTable(cells)TableAgrega un nuevo Table que contiene las celdas especificadas.
appendTable(table)TableAgrega el Table determinado.
clear()TableCellBorra el contenido del elemento.
copy()TableCellDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getBackgroundColor()String|nullRecupera el color de fondo.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getColSpan()IntegerRecupera la extensión de la columna, que es la cantidad de columnas de celdas de la tabla que abarca esta celda.
getLinkUrl()String|nullRecupera la URL del vínculo.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getPaddingBottom()Number|nullRecupera el padding inferior, en puntos.
getPaddingLeft()Number|nullRecupera el padding izquierdo, en puntos.
getPaddingRight()Number|nullRecupera el padding derecho, en puntos.
getPaddingTop()Number|nullRecupera el padding superior, en puntos.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getParentRow()TableRow|nullRecupera el TableRow que contiene el TableCell actual.
getParentTable()Table|nullRecupera el Table que contiene el TableCell actual.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getRowSpan()IntegerRecupera la extensión de la fila, que es la cantidad de filas de celdas de la tabla que abarca esta celda.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
getVerticalAlignment()VerticalAlignment|nullRecupera el VerticalAlignment.
getWidth()Number|nullRecupera el ancho de la columna que contiene la celda, en puntos.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserta un nuevo HorizontalRule en el índice especificado.
insertImage(childIndex, image)InlineImageCrea e inserta un InlineImage a partir del blob de imagen especificado en el índice especificado.
insertImage(childIndex, image)InlineImageInserta el InlineImage proporcionado en el índice especificado.
insertListItem(childIndex, listItem)ListItemInserta el ListItem proporcionado en el índice especificado.
insertListItem(childIndex, text)ListItemCrea e inserta un nuevo ListItem en el índice especificado.
insertParagraph(childIndex, paragraph)ParagraphInserta el Paragraph proporcionado en el índice especificado.
insertParagraph(childIndex, text)ParagraphCrea e inserta un nuevo Paragraph en el índice especificado.
insertTable(childIndex)TableCrea e inserta un nuevo Table en el índice especificado.
insertTable(childIndex, cells)TableCrea e inserta un nuevo Table que contiene las celdas especificadas en el índice especificado.
insertTable(childIndex, table)TableInserta el Table proporcionado en el índice especificado.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()TableCell|nullCombina el elemento con el hermano anterior del mismo tipo.
removeChild(child)TableCellQuita el elemento secundario especificado.
removeFromParent()TableCell|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)TableCellEstablece los atributos del elemento.
setBackgroundColor(color)TableCellEstablece el color de fondo.
setLinkUrl(url)TableCellEstablece la URL del vínculo.
setPaddingBottom(paddingBottom)TableCellEstablece el padding inferior, en puntos.
setPaddingLeft(paddingLeft)TableCellEstablece el padding izquierdo, en puntos.
setPaddingRight(paddingRight)TableCellEstablece el padding derecho, en puntos.
setPaddingTop(paddingTop)TableCellEstablece el padding superior en puntos.
setText(text)TableCellEstablece el contenido como texto sin formato.
setTextAlignment(textAlignment)TableCellEstablece la alineación del texto.
setVerticalAlignment(alignment)TableCellEstablece la alineación vertical.
setWidth(width)TableCellEstablece el ancho de la columna que contiene la celda actual, en puntos.

TableOfContents

Métodos

MétodoTipo de datos que se muestraDescripción breve
clear()TableOfContentsBorra el contenido del elemento.
copy()TableOfContentsDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getLinkUrl()String|nullRecupera la URL del vínculo.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
removeFromParent()TableOfContents|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)TableOfContentsEstablece los atributos del elemento.
setLinkUrl(url)TableOfContentsEstablece la URL del vínculo.
setTextAlignment(textAlignment)TableOfContentsEstablece la alineación del texto.

TableRow

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendTableCell()TableCellCrea y agrega un nuevo TableCell.
appendTableCell(textContents)TableCellAnexa el TableCell proporcionado que contiene el texto especificado.
appendTableCell(tableCell)TableCellAgrega el TableCell determinado.
clear()TableRowBorra el contenido del elemento.
copy()TableRowDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getCell(cellIndex)TableCell|nullRecupera el TableCell en el índice de celda especificado.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getLinkUrl()String|nullRecupera la URL del vínculo.
getMinimumHeight()Number|nullRecupera la altura mínima en puntos.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumCells()IntegerRecupera la cantidad de celdas de la fila.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getParentTable()Table|nullRecupera el Table que contiene la fila actual.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertTableCell(childIndex)TableCellCrea e inserta un nuevo TableCell en el índice especificado.
insertTableCell(childIndex, textContents)TableCellInserta el TableCell proporcionado en el índice especificado, que contiene el texto proporcionado.
insertTableCell(childIndex, tableCell)TableCellInserta el TableCell proporcionado en el índice especificado.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()TableRow|nullCombina el elemento con el hermano anterior del mismo tipo.
removeCell(cellIndex)TableCellQuita el TableCell en el índice de celda especificado.
removeChild(child)TableRowQuita el elemento secundario especificado.
removeFromParent()TableRow|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)TableRowEstablece los atributos del elemento.
setLinkUrl(url)TableRowEstablece la URL del vínculo.
setMinimumHeight(minHeight)TableRowEstablece la altura mínima en puntos.
setTextAlignment(textAlignment)TableRowEstablece la alineación del texto.

Text

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendText(text)TextAgrega el texto especificado al final de esta región de texto.
copy()TextDevuelve una copia profunda y separada del elemento actual.
deleteText(startOffset, endOffsetInclusive)TextBorra un rango de texto.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getAttributes(offset)ObjectRecupera los atributos en el desplazamiento de caracteres especificado.
getBackgroundColor()String|nullRecupera el parámetro de configuración del color de fondo.
getBackgroundColor(offset)String|nullRecupera el color de fondo en el desplazamiento de caracteres especificado.
getFontFamily()String|nullRecupera el parámetro de configuración de la familia de fuentes.
getFontFamily(offset)String|nullRecupera la familia de fuentes en el desplazamiento de caracteres especificado.
getFontSize()Number|nullRecupera el parámetro de configuración del tamaño de la fuente.
getFontSize(offset)Number|nullRecupera el tamaño de fuente en el desplazamiento de caracteres especificado.
getForegroundColor()String|nullRecupera el parámetro de configuración del color de primer plano.
getForegroundColor(offset)String|nullRecupera el color de primer plano en el desplazamiento de caracteres especificado.
getLinkUrl()String|nullRecupera la URL del vínculo.
getLinkUrl(offset)String|nullRecupera la URL del vínculo en el desplazamiento de caracteres especificado.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getTextAlignment(offset)TextAlignment|nullObtiene la alineación del texto para un solo carácter.
getTextAttributeIndices()Integer[]Recupera el conjunto de índices de texto que corresponden al inicio de ejecuciones de formato de texto distintas.
getType()ElementTypeRecupera el ElementType del elemento.
insertText(offset, text)TextInserta el texto especificado en el desplazamiento de caracteres determinado.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
isBold()Boolean|nullRecupera el parámetro de configuración de negrita.
isBold(offset)Boolean|nullRecupera el parámetro de configuración de negrita en el desplazamiento de caracteres especificado.
isItalic()Boolean|nullRecupera el parámetro de configuración de cursiva.
isItalic(offset)Boolean|nullRecupera el parámetro de configuración de cursiva en el desplazamiento de carácter especificado.
isStrikethrough()Boolean|nullRecupera el parámetro de configuración de tachado.
isStrikethrough(offset)Boolean|nullRecupera el parámetro de configuración de tachado en el desplazamiento de carácter especificado.
isUnderline()Boolean|nullRecupera el parámetro de configuración de subrayado.
isUnderline(offset)Boolean|nullRecupera el parámetro de configuración de subrayado en el desplazamiento de carácter especificado.
merge()Text|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()Text|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(startOffset, endOffsetInclusive, attributes)TextAplica los atributos especificados al rango de caracteres determinado.
setAttributes(attributes)TextEstablece los atributos del elemento.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextEstablece el color de fondo para el rango de caracteres especificado.
setBackgroundColor(color)TextEstablece el color de fondo.
setBold(bold)TextEstablece el parámetro de configuración de negrita.
setBold(startOffset, endOffsetInclusive, bold)TextEstablece el parámetro de configuración de negrita para el rango de caracteres especificado.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextEstablece la familia de fuentes para el rango de caracteres especificado.
setFontFamily(fontFamilyName)TextEstablece la familia de fuentes.
setFontSize(startOffset, endOffsetInclusive, size)TextEstablece el tamaño de fuente para el rango de caracteres especificado.
setFontSize(size)TextEstablece el tamaño de la fuente.
setForegroundColor(startOffset, endOffsetInclusive, color)TextEstablece el color de primer plano para el rango de caracteres especificado.
setForegroundColor(color)TextEstablece el color de primer plano.
setItalic(italic)TextEstablece el parámetro de configuración de cursiva.
setItalic(startOffset, endOffsetInclusive, italic)TextEstablece el parámetro de configuración de cursiva para el rango de caracteres especificado.
setLinkUrl(startOffset, endOffsetInclusive, url)TextEstablece la URL del vínculo para el rango de caracteres especificado.
setLinkUrl(url)TextEstablece la URL del vínculo.
setStrikethrough(strikethrough)TextEstablece el parámetro de configuración de tachado.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextEstablece el parámetro de configuración de tachado para el rango de caracteres especificado.
setText(text)TextEstablece el contenido del texto.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextEstablece la alineación del texto para un rango de caracteres determinado.
setTextAlignment(textAlignment)TextEstablece la alineación del texto.
setUnderline(underline)TextEstablece el parámetro de configuración de subrayado.
setUnderline(startOffset, endOffsetInclusive, underline)TextEstablece el parámetro de configuración de subrayado para el rango de caracteres especificado.

TextAlignment

Propiedades

PropiedadTipoDescripción
NORMALEnumEs la alineación de texto normal.
SUPERSCRIPTEnumEs la alineación del texto en superíndice.
SUBSCRIPTEnumEs la alineación del texto del subíndice.

UnsupportedElement

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()UnsupportedElementDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()UnsupportedElement|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()UnsupportedElement|nullQuita el elemento de su elemento superior.
setAttributes(attributes)UnsupportedElementEstablece los atributos del elemento.

VerticalAlignment

Propiedades

PropiedadTipoDescripción
BOTTOMEnumOpción de alineación inferior.
CENTEREnumOpción de alineación central.
TOPEnumEs la opción de alineación superior.