Este servicio permite que las secuencias de comandos creen, accedan y modifiquen archivos de Google Docs.
// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');
// Create and open a document.
doc = DocumentApp.create('Document Name');
Clases
Nombre | Descripción breve |
---|---|
Attribute | Una enumeración de los atributos del elemento. |
Body | Un elemento que representa el cuerpo de un documento. |
Bookmark | Un objeto que representa un favorito. |
ContainerElement | Un elemento genérico que puede contener otros elementos. |
Date | Un elemento que representa una fecha con formato |
Document | Un documento que contiene texto enriquecido y elementos como tablas y listas. |
DocumentApp | El servicio de documentos crea y abre Documents , que se puede editar. |
Element | Un elemento genérico. |
ElementType | Una enumeración de todos los tipos de elementos. |
Equation | Un elemento que representa una expresión matemática. |
EquationFunction | Un elemento que representa una función en un Equation matemático. |
EquationFunctionArgumentSeparator | Un elemento que representa un separador de función en un Equation matemático. |
EquationSymbol | Un elemento que representa un símbolo en un Equation matemático. |
| Una enumeración de las fuentes compatibles. |
FooterSection | Un elemento que representa una sección de pie de página. |
Footnote | Un elemento que representa una nota al pie. |
FootnoteSection | Un elemento que representa una sección de nota al pie. |
GlyphType | Una enumeración de los tipos de glifos compatibles. |
HeaderSection | Un elemento que representa una sección de encabezado. |
HorizontalAlignment | Una enumeración de los tipos de alineación horizontal admitidos. |
HorizontalRule | Un elemento que representa una regla horizontal. |
InlineDrawing | Un elemento que representa un dibujo incorporado. |
InlineImage | Un elemento que representa una imagen incorporada. |
ListItem | Un elemento que representa un elemento de la lista. |
NamedRange | Un objeto Range que tiene un nombre y un ID para permitir la recuperación posterior |
PageBreak | Un elemento que representa un salto de página. |
Paragraph | Un elemento que representa un párrafo. |
ParagraphHeading | Una enumeración de los encabezados de párrafo estándar. |
Person | Un elemento que representa un vínculo a una persona. |
Position | Una referencia a una ubicación en el documento, en relación con un elemento específico. |
PositionedImage | Se corrigió la imagen de la posición fijada en un Paragraph . |
PositionedLayout | Es una enumeración que especifica cómo distribuir una PositionedImage en relación con el texto circundante. |
Range | Rango de elementos de un documento |
RangeBuilder | Un compilador que se usa para construir objetos Range a partir de elementos de documentos. |
RangeElement | Un wrapper alrededor de un Element con un posible desplazamiento inicial y final |
RichLink | Un elemento que representa un vínculo a un recurso de Google, como un archivo de Drive o un video de YouTube. |
Table | Un elemento que representa una tabla. |
TableCell | Un elemento que representa una celda de la tabla. |
TableOfContents | Un elemento que contiene un índice. |
TableRow | Un elemento que representa una fila de la tabla. |
Text | Un elemento que representa una región de texto enriquecido. |
TextAlignment | Una enumeración del tipo de alineaciones de texto. |
UnsupportedElement | 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. |
VerticalAlignment | Una enumeración de los tipos de alineación vertical admitidos. |
Attribute
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
BACKGROUND_COLOR | Enum | El color de fondo de un elemento (Párrafo, Tabla, etc.) o documento. |
BOLD | Enum | La configuración del grosor de la fuente para texto enriquecido |
BORDER_COLOR | Enum | El color del borde de los elementos de la tabla |
BORDER_WIDTH | Enum | Ancho del borde en puntos, para los elementos de la tabla. |
CODE | Enum | El contenido del código, para elementos de ecuación. |
FONT_FAMILY | Enum | La configuración de la familia de fuentes, para texto enriquecido |
FONT_SIZE | Enum | Configuración de tamaño de fuente en puntos para texto enriquecido. |
FOREGROUND_COLOR | Enum | La configuración de color en primer plano, para texto enriquecido. |
HEADING | Enum | El tipo de encabezado, para los elementos de párrafo (por ejemplo, DocumentApp.ParagraphHeading.HEADING1 ) |
HEIGHT | Enum | La configuración de altura, para los elementos de imagen. |
HORIZONTAL_ALIGNMENT | Enum | Alineación horizontal para elementos de párrafo (por ejemplo, DocumentApp.HorizontalAlignment.CENTER ). |
INDENT_END | Enum | Es la configuración de sangría final en puntos para los elementos de párrafo. |
INDENT_FIRST_LINE | Enum | Sangría en la primera línea en puntos, para elementos de párrafo. |
INDENT_START | Enum | Es la configuración de sangría inicial en puntos, para los elementos de párrafo. |
ITALIC | Enum | Configuración de estilo de fuente para texto enriquecido |
GLYPH_TYPE | Enum | El tipo de glifo, para los elementos del elemento de lista. |
LEFT_TO_RIGHT | Enum | La configuración de dirección del texto, para el texto enriquecido. |
LINE_SPACING | Enum | La configuración de interlineado como multiplicador para los elementos de párrafo. |
LINK_URL | Enum | La URL del vínculo para el texto enriquecido |
LIST_ID | Enum | ID de la lista abarcadora, para los elementos del elemento de lista. |
MARGIN_BOTTOM | Enum | La configuración del margen inferior en puntos para los elementos de párrafo. |
MARGIN_LEFT | Enum | La configuración del margen izquierdo en puntos para los elementos de párrafo. |
MARGIN_RIGHT | Enum | La configuración de margen derecho en puntos para los elementos de párrafo. |
MARGIN_TOP | Enum | La configuración de margen superior en puntos para los elementos de párrafo. |
NESTING_LEVEL | Enum | El nivel de anidamiento de elementos para elementos de lista |
MINIMUM_HEIGHT | Enum | La configuración de altura mínima en puntos para los elementos de fila de la tabla. |
PADDING_BOTTOM | Enum | La configuración de relleno inferior en puntos, para los elementos de la celda de tabla. |
PADDING_LEFT | Enum | Configuración de padding izquierdo en puntos, para los elementos de celda de tabla |
PADDING_RIGHT | Enum | La configuración de relleno adecuada en puntos para los elementos de celda de tabla |
PADDING_TOP | Enum | Configuración de padding superior en puntos, para los elementos de celda de tabla |
PAGE_HEIGHT | Enum | La configuración de altura de la página, en puntos, para los documentos. |
PAGE_WIDTH | Enum | La configuración del ancho de la página, en puntos, para los documentos. |
SPACING_AFTER | Enum | La configuración de espacio inferior en puntos para los elementos de párrafo. |
SPACING_BEFORE | Enum | La configuración de espaciado superior en puntos para elementos de párrafo. |
STRIKETHROUGH | Enum | La configuración tachada para el texto enriquecido. |
UNDERLINE | Enum | La configuración de subrayado, para texto enriquecido |
VERTICAL_ALIGNMENT | Enum | La configuración de alineación vertical para elementos de celda de tabla |
WIDTH | Enum | La configuración de ancho para elementos de imagen y celda de tabla. |
Body
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crea y agrega un nuevo HorizontalRule . |
appendImage(image) | InlineImage | Crea y agrega un InlineImage nuevo desde el BLOB de imagen especificado. |
appendImage(image) | InlineImage | Agrega el valor InlineImage proporcionado. |
appendListItem(listItem) | ListItem | Agrega el valor ListItem proporcionado. |
appendListItem(text) | ListItem | Crea y agrega una nueva ListItem con el contenido de texto especificado. |
appendPageBreak() | PageBreak | Crea y agrega un nuevo PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Agrega el valor PageBreak proporcionado. |
appendParagraph(paragraph) | Paragraph | Agrega el valor Paragraph proporcionado. |
appendParagraph(text) | Paragraph | Crea y agrega una nueva Paragraph con el contenido de texto especificado. |
appendTable() | Table | Crea y agrega un nuevo Table . |
appendTable(cells) | Table | Agrega un nuevo Table que contenga un TableCell para cada valor de string especificado. |
appendTable(table) | Table | Agrega el valor Table proporcionado. |
clear() | Body | Borra el contenido del elemento. |
copy() | Body | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getHeadingAttributes(paragraphHeading) | Object | Recupera el conjunto de atributos del ParagraphHeading proporcionado. |
getImages() | InlineImage[] | Recupera todos los InlineImages contenidos en la sección. |
getListItems() | ListItem[] | Recupera todos los ListItems contenidos en la sección. |
getMarginBottom() | Number | Recupera el margen inferior, en puntos. |
getMarginLeft() | Number | Recupera el margen izquierdo, en puntos. |
getMarginRight() | Number | Recupera el margen derecho. |
getMarginTop() | Number | Recupera el margen superior. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getPageHeight() | Number | Recupera la altura de la página en puntos. |
getPageWidth() | Number | Recupera el ancho de la página en puntos. |
getParagraphs() | Paragraph[] | Recupera todos los Paragraphs contenidos en la sección (incluido ListItems ). |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getTables() | Table[] | Recupera todos los Tables contenidos en la sección. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea e inserta un nuevo HorizontalRule en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Crea e inserta un InlineImage del BLOB de imagen especificado, en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Inserta la InlineImage especificada en el índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Inserta la ListItem especificada en el índice especificado. |
insertListItem(childIndex, text) | ListItem | Crea e inserta un nuevo ListItem en el índice especificado, que contiene el contenido de texto especificado. |
insertPageBreak(childIndex) | PageBreak | Crea e inserta un nuevo PageBreak en el índice especificado. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Inserta la PageBreak especificada en el índice especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Inserta la Paragraph especificada en el índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Crea e inserta un nuevo Paragraph en el índice especificado, que contiene el contenido de texto especificado. |
insertTable(childIndex) | Table | Crea e inserta un nuevo Table en el índice especificado. |
insertTable(childIndex, cells) | Table | Crea e inserta un nuevo objeto Table que contiene las celdas especificadas en el índice especificado. |
insertTable(childIndex, table) | Table | Inserta la Table especificada en el índice especificado. |
removeChild(child) | Body | Quita el elemento secundario especificado. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | Body | Establece los atributos del elemento. |
setHeadingAttributes(paragraphHeading, attributes) | Body | Configura los atributos para la ParagraphHeading proporcionada. |
setMarginBottom(marginBottom) | Body | Establece el margen inferior, en puntos. |
setMarginLeft(marginLeft) | Body | Establece el margen izquierdo, en puntos. |
setMarginRight(marginRight) | Body | Establece el margen derecho, en puntos. |
setMarginTop(marginTop) | Body | Establece el margen superior. |
setPageHeight(pageHeight) | Body | Establece la altura de la página, en puntos. |
setPageWidth(pageWidth) | Body | Establece el ancho de la página, en puntos. |
setText(text) | Body | Establece el contenido como texto sin formato. |
setTextAlignment(textAlignment) | Body | Establece la alineación del texto. |
Bookmark
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getId() | String | Obtiene el ID de Bookmark . |
getPosition() | Position | Obtiene el Position de Bookmark dentro de Document . |
remove() | void | Borra el Bookmark . |
ContainerElement
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
asBody() | Body | Muestra el elemento actual como Body . |
asEquation() | Equation | Muestra el elemento actual como Equation . |
asFooterSection() | FooterSection | Muestra el elemento actual como FooterSection . |
asFootnoteSection() | FootnoteSection | Muestra el elemento actual como FootnoteSection . |
asHeaderSection() | HeaderSection | Muestra el elemento actual como HeaderSection . |
asListItem() | ListItem | Muestra el elemento actual como ListItem . |
asParagraph() | Paragraph | Muestra el elemento actual como Paragraph . |
asTable() | Table | Muestra el elemento actual como Table . |
asTableCell() | TableCell | Muestra el elemento actual como TableCell . |
asTableOfContents() | TableOfContents | Muestra el elemento actual como TableOfContents . |
asTableRow() | TableRow | Muestra el elemento actual como TableRow . |
clear() | ContainerElement | Borra el contenido del elemento. |
copy() | ContainerElement | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | ContainerElement | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | ContainerElement | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | ContainerElement | Establece los atributos del elemento. |
setLinkUrl(url) | ContainerElement | Configura la URL del vínculo. |
setTextAlignment(textAlignment) | ContainerElement | Establece la alineación del texto. |
Date
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | Date | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getDisplayText() | String | Muestra el valor que se muestra en el documento. |
getLocale() | String | Muestra la configuración regional de la fecha que se usó para el valor de visualización. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getTimestamp() | Date | Muestra la marca de tiempo asociada con la fecha. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | Date | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | Date | Quita el elemento de su elemento superior. |
setAttributes(attributes) | Date | Establece los atributos del elemento. |
Document
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addBookmark(position) | Bookmark | Agrega un Bookmark en el Position determinado. |
addEditor(emailAddress) | Document | Agrega el usuario determinado a la lista de editores de Document . |
addEditor(user) | Document | Agrega el usuario determinado a la lista de editores de Document . |
addEditors(emailAddresses) | Document | Agrega el array de usuarios determinado a la lista de editores de Document . |
addFooter() | FooterSection | Agrega una sección de pie de página del documento, si no existe. |
addHeader() | HeaderSection | Agrega una sección de encabezado del documento, si no existe. |
addNamedRange(name, range) | NamedRange | Agrega un NamedRange , que es un Range que tiene un nombre y un ID para usar en la recuperación posterior. |
addViewer(emailAddress) | Document | Agrega el usuario determinado a la lista de lectores de Document . |
addViewer(user) | Document | Agrega el usuario determinado a la lista de lectores de Document . |
addViewers(emailAddresses) | Document | Agrega el array de usuarios determinado a la lista de lectores de Document . |
getAs(contentType) | Blob | Recupera el contenido de Document actual como un BLOB del tipo especificado. |
getBlob() | Blob | Recupera el contenido Document actual como un BLOB. |
getBody() | Body | Recupera el objeto Body del documento activo. |
getBookmark(id) | Bookmark | Obtiene el Bookmark con el ID determinado. |
getBookmarks() | Bookmark[] | Obtiene todos los objetos Bookmark del documento. |
getCursor() | Position | Obtiene el cursor del usuario en el documento activo. |
getEditors() | User[] | Obtiene la lista de editores de este Document . |
getFooter() | FooterSection | Recupera la sección de pie de página del documento, si existe. |
getFootnotes() | Footnote[] | Recupera todos los elementos Footnote en el cuerpo del documento. |
getHeader() | HeaderSection | Recupera la sección de encabezado del documento, si existe. |
getId() | String | Recupera el identificador único del documento. |
getLanguage() | String | Obtiene el código de idioma del documento. |
getName() | String | Recupera el título del documento. |
getNamedRangeById(id) | NamedRange | Obtiene el NamedRange con el ID determinado. |
getNamedRanges() | NamedRange[] | Obtiene todos los objetos NamedRange del documento. |
getNamedRanges(name) | NamedRange[] | Obtiene todos los objetos NamedRange del documento con el nombre determinado. |
getSelection() | Range | Obtiene la selección del usuario en el documento activo. |
getSupportedLanguageCodes() | String[] | Obtiene todos los códigos de idioma que se admiten en los archivos de Documentos de Google. |
getUrl() | String | Recupera la URL para acceder al documento actual. |
getViewers() | User[] | Obtiene la lista de lectores y comentaristas de este Document . |
newPosition(element, offset) | Position | Crea un Position nuevo, que es una referencia a una ubicación en el documento, en relación con un elemento específico. |
newRange() | RangeBuilder | Crea un compilador que se usa para construir objetos Range a partir de elementos de documentos. |
removeEditor(emailAddress) | Document | Quita el usuario determinado de la lista de editores de Document . |
removeEditor(user) | Document | Quita el usuario determinado de la lista de editores de Document . |
removeViewer(emailAddress) | Document | Quita el usuario determinado de la lista de lectores y comentaristas del Document . |
removeViewer(user) | Document | Quita el usuario determinado de la lista de lectores y comentaristas del Document . |
saveAndClose() | void | Guarda el Document actual. |
setCursor(position) | Document | Establece el cursor del usuario en el documento activo, según un Position . |
setLanguage(languageCode) | Document | Establece el código de idioma del documento. |
setName(name) | Document | Establece el título del documento. |
setSelection(range) | Document | Establece la selección del usuario en el documento activo, dada una Range . |
DocumentApp
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
Attribute | Attribute | La enumeración Attribute . |
ElementType | ElementType | La enumeración ElementType . |
FontFamily |
| La enumeración . |
GlyphType | GlyphType | La enumeración GlyphType . |
HorizontalAlignment | HorizontalAlignment | La enumeración HorizontalAlignment . |
ParagraphHeading | ParagraphHeading | La enumeración ParagraphHeading . |
PositionedLayout | PositionedLayout | La enumeración PositionedLayout . |
TextAlignment | TextAlignment | La enumeración TextAlignment . |
VerticalAlignment | VerticalAlignment | La enumeración VerticalAlignment . |
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
create(name) | Document | Crea y muestra un nuevo documento. |
getActiveDocument() | Document | Muestra el documento al que está vinculada el contenedor de la secuencia de comandos. |
getUi() | Ui | Muestra una instancia del entorno de interfaz de usuario del documento que permite que la secuencia de comandos agregue características como menús, diálogos y barras laterales. |
openById(id) | Document | Muestra el documento con el ID especificado. |
openByUrl(url) | Document | Abre y muestra el documento con la URL especificada. |
Element
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
asBody() | Body | Muestra el elemento actual como Body . |
asDate() | Date | Muestra el elemento actual como Date . |
asEquation() | Equation | Muestra el elemento actual como Equation . |
asEquationFunction() | EquationFunction | Muestra el elemento actual como EquationFunction . |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | Muestra el elemento actual como EquationFunctionArgumentSeparator . |
asEquationSymbol() | EquationSymbol | Muestra el elemento actual como EquationSymbol . |
asFooterSection() | FooterSection | Muestra el elemento actual como FooterSection . |
asFootnote() | Footnote | Muestra el elemento actual como Footnote . |
asFootnoteSection() | FootnoteSection | Muestra el elemento actual como FootnoteSection . |
asHeaderSection() | HeaderSection | Muestra el elemento actual como HeaderSection . |
asHorizontalRule() | HorizontalRule | Muestra el elemento actual como HorizontalRule . |
asInlineDrawing() | InlineDrawing | Muestra el elemento actual como InlineDrawing . |
asInlineImage() | InlineImage | Muestra el elemento actual como InlineImage . |
asListItem() | ListItem | Muestra el elemento actual como ListItem . |
asPageBreak() | PageBreak | Muestra el elemento actual como PageBreak . |
asParagraph() | Paragraph | Muestra el elemento actual como Paragraph . |
asPerson() | Person | Muestra el elemento actual como Person . |
asRichLink() | RichLink | Muestra el elemento actual como RichLink , por ejemplo, un vínculo a un archivo de Hojas de cálculo de Google. |
asTable() | Table | Muestra el elemento actual como Table . |
asTableCell() | TableCell | Muestra el elemento actual como TableCell . |
asTableOfContents() | TableOfContents | Muestra el elemento actual como TableOfContents . |
asTableRow() | TableRow | Muestra el elemento actual como TableRow . |
asText() | Text | Muestra el elemento actual como Text . |
copy() | Element | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | Element | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | Element | Quita el elemento de su elemento superior. |
setAttributes(attributes) | Element | Establece los atributos del elemento. |
ElementType
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
BODY_SECTION | Enum | El tipo correspondiente al elemento Body . |
COMMENT_SECTION | Enum | El tipo correspondiente al elemento . |
DATE | Enum | El tipo correspondiente al elemento Date . |
DOCUMENT | Enum | El tipo que corresponde a la raíz del documento. |
EQUATION | Enum | El tipo correspondiente al elemento Equation . |
EQUATION_FUNCTION | Enum | El tipo correspondiente al elemento EquationFunction . |
EQUATION_FUNCTION_ARGUMENT_SEPARATOR | Enum | El tipo correspondiente al elemento EquationFunctionArgumentSeparator . |
EQUATION_SYMBOL | Enum | El tipo correspondiente al elemento EquationSymbol . |
RICH_LINK | Enum | El tipo correspondiente al elemento RichLink . |
FOOTER_SECTION | Enum | El tipo correspondiente al elemento FooterSection . |
FOOTNOTE | Enum | El tipo correspondiente al elemento Footnote . |
FOOTNOTE_SECTION | Enum | El tipo correspondiente al elemento FootnoteSection . |
HEADER_SECTION | Enum | El tipo correspondiente al elemento HeaderSection . |
HORIZONTAL_RULE | Enum | El tipo correspondiente al elemento HorizontalRule . |
INLINE_DRAWING | Enum | El tipo correspondiente al elemento InlineDrawing . |
INLINE_IMAGE | Enum | El tipo correspondiente al elemento InlineImage . |
LIST_ITEM | Enum | El tipo correspondiente al elemento ListItem . |
PAGE_BREAK | Enum | El tipo correspondiente al elemento PageBreak . |
PARAGRAPH | Enum | El tipo correspondiente al elemento Paragraph . |
PERSON | Enum | El tipo correspondiente al elemento Person . |
TABLE | Enum | El tipo correspondiente al elemento Table . |
TABLE_CELL | Enum | El tipo correspondiente al elemento TableCell . |
TABLE_OF_CONTENTS | Enum | El tipo correspondiente al elemento TableOfContents . |
TABLE_ROW | Enum | El tipo correspondiente al elemento TableRow . |
TEXT | Enum | El tipo correspondiente al elemento Text . |
UNSUPPORTED | Enum | El tipo correspondiente a UnsupportedElement . |
Equation
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
clear() | Equation | Borra el contenido del elemento. |
copy() | Equation | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | Equation | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | Equation | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | Equation | Establece los atributos del elemento. |
setLinkUrl(url) | Equation | Configura la URL del vínculo. |
setTextAlignment(textAlignment) | Equation | Establece la alineación del texto. |
EquationFunction
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
clear() | EquationFunction | Borra el contenido del elemento. |
copy() | EquationFunction | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getCode() | String | Recupera el código que corresponde a la función de ecuación. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | EquationFunction | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | EquationFunction | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | EquationFunction | Establece los atributos del elemento. |
setLinkUrl(url) | EquationFunction | Configura la URL del vínculo. |
setTextAlignment(textAlignment) | EquationFunction | Establece la alineación del texto. |
EquationFunctionArgumentSeparator
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | EquationFunctionArgumentSeparator | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | EquationFunctionArgumentSeparator | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | EquationFunctionArgumentSeparator | Quita el elemento de su elemento superior. |
setAttributes(attributes) | EquationFunctionArgumentSeparator | Establece los atributos del elemento. |
EquationSymbol
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | EquationSymbol | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getCode() | String | Recupera el código que corresponde al símbolo de ecuación. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | EquationSymbol | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | EquationSymbol | Quita el elemento de su elemento superior. |
setAttributes(attributes) | EquationSymbol | Establece los atributos del elemento. |
FontFamily
FooterSection
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crea y agrega un nuevo HorizontalRule . |
appendImage(image) | InlineImage | Crea y agrega un InlineImage nuevo desde el BLOB de imagen especificado. |
appendImage(image) | InlineImage | Agrega el valor InlineImage proporcionado. |
appendListItem(listItem) | ListItem | Agrega el valor ListItem proporcionado. |
appendListItem(text) | ListItem | Crea y agrega una nueva ListItem con el contenido de texto especificado. |
appendParagraph(paragraph) | Paragraph | Agrega el valor Paragraph proporcionado. |
appendParagraph(text) | Paragraph | Crea y agrega una nueva Paragraph con el contenido de texto especificado. |
appendTable() | Table | Crea y agrega un nuevo Table . |
appendTable(cells) | Table | Agrega un nuevo Table que contenga un TableCell para cada valor de string especificado. |
appendTable(table) | Table | Agrega el valor Table proporcionado. |
clear() | FooterSection | Borra el contenido del elemento. |
copy() | FooterSection | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getImages() | InlineImage[] | Recupera todos los InlineImages contenidos en la sección. |
getListItems() | ListItem[] | Recupera todos los ListItems contenidos en la sección. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParagraphs() | Paragraph[] | Recupera todos los Paragraphs contenidos en la sección (incluido ListItems ). |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getTables() | Table[] | Recupera todos los Tables contenidos en la sección. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea e inserta un nuevo HorizontalRule en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Crea e inserta un InlineImage del BLOB de imagen especificado, en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Inserta la InlineImage especificada en el índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Inserta la ListItem especificada en el índice especificado. |
insertListItem(childIndex, text) | ListItem | Crea e inserta un nuevo ListItem en el índice especificado, que contiene el contenido de texto especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Inserta la Paragraph especificada en el índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Crea e inserta un nuevo Paragraph en el índice especificado, que contiene el contenido de texto especificado. |
insertTable(childIndex) | Table | Crea e inserta un nuevo Table en el índice especificado. |
insertTable(childIndex, cells) | Table | Crea e inserta un nuevo objeto Table que contiene las celdas especificadas en el índice especificado. |
insertTable(childIndex, table) | Table | Inserta la Table especificada en el índice especificado. |
removeChild(child) | FooterSection | Quita el elemento secundario especificado. |
removeFromParent() | FooterSection | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | FooterSection | Establece los atributos del elemento. |
setText(text) | FooterSection | Establece el contenido como texto sin formato. |
setTextAlignment(textAlignment) | FooterSection | Establece la alineación del texto. |
Footnote
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | Footnote | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getFootnoteContents() | FootnoteSection | Recupera el contenido del elemento de la nota al pie. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
removeFromParent() | Footnote | Quita el elemento de su elemento superior. |
setAttributes(attributes) | Footnote | Establece los atributos del elemento. |
FootnoteSection
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
appendParagraph(paragraph) | Paragraph | Agrega el valor Paragraph proporcionado. |
appendParagraph(text) | Paragraph | Crea y agrega una nueva Paragraph con el contenido de texto especificado. |
clear() | FootnoteSection | Borra el contenido del elemento. |
copy() | FootnoteSection | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParagraphs() | Paragraph[] | Recupera todos los Paragraphs contenidos en la sección (incluido ListItems ). |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
insertParagraph(childIndex, paragraph) | Paragraph | Inserta la Paragraph especificada en el índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Crea e inserta un nuevo Paragraph en el índice especificado, que contiene el contenido de texto especificado. |
removeChild(child) | FootnoteSection | Quita el elemento secundario especificado. |
removeFromParent() | FootnoteSection | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | FootnoteSection | Establece los atributos del elemento. |
setText(text) | FootnoteSection | Establece el contenido como texto sin formato. |
setTextAlignment(textAlignment) | FootnoteSection | Establece la alineación del texto. |
GlyphType
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
BULLET | Enum | La viñeta predeterminada, circular y rellenada |
HOLLOW_BULLET | Enum | Una viñeta vacía. |
SQUARE_BULLET | Enum | Una viñeta cuadrada. |
NUMBER | Enum | Una viñeta basada en números. |
LATIN_UPPER | Enum | Una viñeta latina. |
LATIN_LOWER | Enum | Una viñeta de letras latinas. |
ROMAN_UPPER | Enum | Un número romano con viñetas en mayúscula. |
ROMAN_LOWER | Enum | Un número romano con viñetas en minúscula. |
HeaderSection
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crea y agrega un nuevo HorizontalRule . |
appendImage(image) | InlineImage | Crea y agrega un InlineImage nuevo desde el BLOB de imagen especificado. |
appendImage(image) | InlineImage | Agrega el valor InlineImage proporcionado. |
appendListItem(listItem) | ListItem | Agrega el valor ListItem proporcionado. |
appendListItem(text) | ListItem | Crea y agrega una nueva ListItem con el contenido de texto especificado. |
appendParagraph(paragraph) | Paragraph | Agrega el valor Paragraph proporcionado. |
appendParagraph(text) | Paragraph | Crea y agrega una nueva Paragraph con el contenido de texto especificado. |
appendTable() | Table | Crea y agrega un nuevo Table . |
appendTable(cells) | Table | Agrega un nuevo Table que contenga un TableCell para cada valor de string especificado. |
appendTable(table) | Table | Agrega el valor Table proporcionado. |
clear() | HeaderSection | Borra el contenido del elemento. |
copy() | HeaderSection | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getImages() | InlineImage[] | Recupera todos los InlineImages contenidos en la sección. |
getListItems() | ListItem[] | Recupera todos los ListItems contenidos en la sección. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParagraphs() | Paragraph[] | Recupera todos los Paragraphs contenidos en la sección (incluido ListItems ). |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getTables() | Table[] | Recupera todos los Tables contenidos en la sección. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea e inserta un nuevo HorizontalRule en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Crea e inserta un InlineImage del BLOB de imagen especificado, en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Inserta la InlineImage especificada en el índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Inserta la ListItem especificada en el índice especificado. |
insertListItem(childIndex, text) | ListItem | Crea e inserta un nuevo ListItem en el índice especificado, que contiene el contenido de texto especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Inserta la Paragraph especificada en el índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Crea e inserta un nuevo Paragraph en el índice especificado, que contiene el contenido de texto especificado. |
insertTable(childIndex) | Table | Crea e inserta un nuevo Table en el índice especificado. |
insertTable(childIndex, cells) | Table | Crea e inserta un nuevo objeto Table que contiene las celdas especificadas en el índice especificado. |
insertTable(childIndex, table) | Table | Inserta la Table especificada en el índice especificado. |
removeChild(child) | HeaderSection | Quita el elemento secundario especificado. |
removeFromParent() | HeaderSection | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | HeaderSection | Establece los atributos del elemento. |
setText(text) | HeaderSection | Establece el contenido como texto sin formato. |
setTextAlignment(textAlignment) | HeaderSection | Establece la alineación del texto. |
HorizontalAlignment
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
LEFT | Enum | Opción de alineación a la izquierda. |
CENTER | Enum | Opción de alineación central. |
RIGHT | Enum | Opción de alineación a la derecha. |
JUSTIFY | Enum | La opción de alineación |
HorizontalRule
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | HorizontalRule | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
removeFromParent() | HorizontalRule | Quita el elemento de su elemento superior. |
setAttributes(attributes) | HorizontalRule | Establece los atributos del elemento. |
InlineDrawing
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | InlineDrawing | Muestra una copia profunda y separada del elemento actual. |
getAltDescription() | String | Muestra la descripción alternativa del dibujo. |
getAltTitle() | String | Muestra el título alternativo del dibujo. |
getAttributes() | Object | Recupera los atributos del elemento. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | InlineDrawing | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | InlineDrawing | Quita el elemento de su elemento superior. |
setAltDescription(description) | InlineDrawing | Establece la descripción alternativa del dibujo. |
setAltTitle(title) | InlineDrawing | Establece el título alternativo del dibujo. |
setAttributes(attributes) | InlineDrawing | Establece los atributos del elemento. |
InlineImage
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | InlineImage | Muestra una copia profunda y separada del elemento actual. |
getAltDescription() | String | Muestra la descripción alternativa de la imagen. |
getAltTitle() | String | Muestra el título alternativo de la imagen. |
getAs(contentType) | Blob | Muestra los datos de este objeto como un BLOB convertido al tipo de contenido especificado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getBlob() | Blob | Muestra los datos dentro de este objeto como un BLOB. |
getHeight() | Integer | Recupera la altura de la imagen en píxeles. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
getWidth() | Integer | Recupera el ancho de la imagen, en píxeles. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | InlineImage | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | InlineImage | Quita el elemento de su elemento superior. |
setAltDescription(description) | InlineImage | Establece la descripción alternativa de la imagen. |
setAltTitle(title) | InlineImage | Establece el título alternativo de la imagen. |
setAttributes(attributes) | InlineImage | Establece los atributos del elemento. |
setHeight(height) | InlineImage | Establece la altura de la imagen en píxeles. |
setLinkUrl(url) | InlineImage | Establece la URL del vínculo. |
setWidth(width) | InlineImage | Establece el ancho en píxeles de la imagen. |
ListItem
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addPositionedImage(image) | PositionedImage | Crea e inserta un nuevo PositionedImage del BLOB de imagen especificado. |
appendHorizontalRule() | HorizontalRule | Crea y agrega un nuevo HorizontalRule . |
appendInlineImage(image) | InlineImage | Crea y agrega un InlineImage nuevo desde el BLOB de imagen especificado. |
appendInlineImage(image) | InlineImage | Agrega el valor InlineImage proporcionado. |
appendPageBreak() | PageBreak | Crea y agrega un nuevo PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Agrega el valor PageBreak proporcionado. |
appendText(text) | Text | Crea y agrega un nuevo elemento Text con el contenido especificado. |
appendText(text) | Text | Agrega el elemento Text dado. |
clear() | ListItem | Borra el contenido del elemento. |
copy() | ListItem | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAlignment() | HorizontalAlignment | Recupera la HorizontalAlignment . |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getGlyphType() | GlyphType | Recupera el elemento GlyphType de la lista. |
getHeading() | ParagraphHeading | Recupera la ParagraphHeading . |
getIndentEnd() | Number | Recupera la sangría final, en puntos. |
getIndentFirstLine() | Number | Recupera la sangría de la primera línea, en puntos. |
getIndentStart() | Number | Recupera la sangría inicial. |
getLineSpacing() | Number | Recupera el interlineado en puntos. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getListId() | String | Recupera el ID de la lista. |
getNestingLevel() | Integer | Recupera el nivel de anidamiento del elemento de lista. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPositionedImage(id) | PositionedImage | Obtiene un PositionedImage por el ID de la imagen. |
getPositionedImages() | PositionedImage[] | Obtiene todos los objetos PositionedImage anclados al párrafo. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getSpacingAfter() | Number | Recupera el espacio después del elemento, en puntos. |
getSpacingBefore() | Number | Recupera el espacio antes del elemento, en puntos. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea e inserta un HorizontalRule en el índice especificado. |
insertInlineImage(childIndex, image) | InlineImage | Crea y, luego, inserta un InlineImage nuevo desde el BLOB de imagen especificado en el índice especificado. |
insertInlineImage(childIndex, image) | InlineImage | Inserta la InlineImage especificada en el índice especificado. |
insertPageBreak(childIndex) | PageBreak | Crea e inserta un nuevo PageBreak en el índice especificado. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Inserta la PageBreak especificada en el índice especificado. |
insertText(childIndex, text) | Text | Crea e inserta un nuevo elemento de texto en el índice especificado. |
insertText(childIndex, text) | Text | Inserta el elemento Text en el índice especificado, con el contenido de texto especificado. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
isLeftToRight() | Boolean | Recupera la configuración de izquierda a derecha. |
merge() | ListItem | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeChild(child) | ListItem | Quita el elemento secundario especificado. |
removeFromParent() | ListItem | Quita el elemento de su elemento superior. |
removePositionedImage(id) | Boolean | Quita un PositionedImage por el ID de la imagen. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAlignment(alignment) | ListItem | Establece el HorizontalAlignment . |
setAttributes(attributes) | ListItem | Establece los atributos del elemento. |
setGlyphType(glyphType) | ListItem | Configura el GlyphType del elemento de la lista. |
setHeading(heading) | ListItem | Establece el ParagraphHeading . |
setIndentEnd(indentEnd) | ListItem | Establece la sangría final, en puntos. |
setIndentFirstLine(indentFirstLine) | ListItem | Establece la sangría en la primera línea, en puntos. |
setIndentStart(indentStart) | ListItem | Establece la sangría inicial, en puntos. |
setLeftToRight(leftToRight) | ListItem | Establece la configuración de izquierda a derecha. |
setLineSpacing(multiplier) | ListItem | Establece el interlineado, que es una cantidad que indica el número de líneas que se utilizarán para el espaciado. |
setLinkUrl(url) | ListItem | Configura la URL del vínculo. |
setListId(listItem) | ListItem | Establece el ID de la lista. |
setNestingLevel(nestingLevel) | ListItem | Establece el nivel de anidamiento del elemento de la lista. |
setSpacingAfter(spacingAfter) | ListItem | Establece el espacio después del elemento, en puntos. |
setSpacingBefore(spacingBefore) | ListItem | Establece el espacio antes del elemento, en puntos. |
setText(text) | void | Establece el contenido del elemento de la lista como texto. |
setTextAlignment(textAlignment) | ListItem | Establece la alineación del texto. |
NamedRange
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getId() | String | Obtiene el ID de este NamedRange . |
getName() | String | Obtiene el nombre de este NamedRange . |
getRange() | Range | Obtiene el rango de elementos asociados con este NamedRange . |
remove() | void | Quita este NamedRange del documento. |
PageBreak
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | PageBreak | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
removeFromParent() | PageBreak | Quita el elemento de su elemento superior. |
setAttributes(attributes) | PageBreak | Establece los atributos del elemento. |
Paragraph
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addPositionedImage(image) | PositionedImage | Crea e inserta un nuevo PositionedImage del BLOB de imagen especificado. |
appendHorizontalRule() | HorizontalRule | Crea y agrega un nuevo HorizontalRule . |
appendInlineImage(image) | InlineImage | Crea y agrega un InlineImage nuevo desde el BLOB de imagen especificado. |
appendInlineImage(image) | InlineImage | Agrega el valor InlineImage proporcionado. |
appendPageBreak() | PageBreak | Crea y agrega un nuevo PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Agrega el valor PageBreak proporcionado. |
appendText(text) | Text | Crea y agrega un nuevo elemento Text con el contenido especificado. |
appendText(text) | Text | Agrega el elemento Text dado. |
clear() | Paragraph | Borra el contenido del elemento. |
copy() | Paragraph | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAlignment() | HorizontalAlignment | Recupera la HorizontalAlignment . |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getHeading() | ParagraphHeading | Recupera la ParagraphHeading . |
getIndentEnd() | Number | Recupera la sangría final, en puntos. |
getIndentFirstLine() | Number | Recupera la sangría de la primera línea, en puntos. |
getIndentStart() | Number | Recupera la sangría inicial. |
getLineSpacing() | Number | Recupera el interlineado en puntos. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPositionedImage(id) | PositionedImage | Obtiene un PositionedImage por el ID de la imagen. |
getPositionedImages() | PositionedImage[] | Obtiene todos los objetos PositionedImage anclados al párrafo. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getSpacingAfter() | Number | Recupera el espacio después del elemento, en puntos. |
getSpacingBefore() | Number | Recupera el espacio antes del elemento, en puntos. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea e inserta un HorizontalRule en el índice especificado. |
insertInlineImage(childIndex, image) | InlineImage | Crea y, luego, inserta un InlineImage nuevo desde el BLOB de imagen especificado en el índice especificado. |
insertInlineImage(childIndex, image) | InlineImage | Inserta la InlineImage especificada en el índice especificado. |
insertPageBreak(childIndex) | PageBreak | Crea e inserta un nuevo PageBreak en el índice especificado. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Inserta la PageBreak especificada en el índice especificado. |
insertText(childIndex, text) | Text | Crea e inserta un nuevo elemento de texto en el índice especificado. |
insertText(childIndex, text) | Text | Inserta el elemento Text en el índice especificado, con el contenido de texto especificado. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
isLeftToRight() | Boolean | Recupera la configuración de izquierda a derecha. |
merge() | Paragraph | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeChild(child) | Paragraph | Quita el elemento secundario especificado. |
removeFromParent() | Paragraph | Quita el elemento de su elemento superior. |
removePositionedImage(id) | Boolean | Quita un PositionedImage por el ID de la imagen. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAlignment(alignment) | Paragraph | Establece el HorizontalAlignment . |
setAttributes(attributes) | Paragraph | Establece los atributos del elemento. |
setHeading(heading) | Paragraph | Establece el ParagraphHeading . |
setIndentEnd(indentEnd) | Paragraph | Establece la sangría final, en puntos. |
setIndentFirstLine(indentFirstLine) | Paragraph | Establece la sangría en la primera línea, en puntos. |
setIndentStart(indentStart) | Paragraph | Establece la sangría inicial, en puntos. |
setLeftToRight(leftToRight) | Paragraph | Establece la configuración de izquierda a derecha. |
setLineSpacing(multiplier) | Paragraph | Establece el interlineado, que es una cantidad que indica el número de líneas que se utilizarán para el espaciado. |
setLinkUrl(url) | Paragraph | Configura la URL del vínculo. |
setSpacingAfter(spacingAfter) | Paragraph | Establece el espacio después del elemento, en puntos. |
setSpacingBefore(spacingBefore) | Paragraph | Establece el espacio antes del elemento, en puntos. |
setText(text) | void | Establece el contenido del párrafo como texto. |
setTextAlignment(textAlignment) | Paragraph | Establece la alineación del texto. |
ParagraphHeading
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
NORMAL | Enum | Opción de encabezado para texto normal. |
HEADING1 | Enum | La opción de título más alto. |
HEADING2 | Enum | La segunda opción de encabezado. |
HEADING3 | Enum | La tercera opción de encabezado |
HEADING4 | Enum | La cuarta opción de encabezado. |
HEADING5 | Enum | La quinta opción del encabezado. |
HEADING6 | Enum | La opción de título más bajo. |
TITLE | Enum | Opción de encabezado del título. |
SUBTITLE | Enum | La opción de encabezado. |
Person
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | Person | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getEmail() | String | Muestra la dirección de correo electrónico de la persona. |
getName() | String | Muestra el nombre visible de la persona, si se estableció. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | Person | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | Person | Quita el elemento de su elemento superior. |
setAttributes(attributes) | Person | Establece los atributos del elemento. |
Position
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getElement() | Element | Obtiene el elemento que contiene este Position . |
getOffset() | Integer | Obtiene la ubicación relativa de este Position dentro del elemento que lo contiene. |
getSurroundingText() | Text | Crea un elemento Text artificial que representa el texto y el formato de los elementos Paragraph o ListItem que contiene el elemento Position , ya sea directamente o a través de una cadena de elementos secundarios. |
getSurroundingTextOffset() | Integer | Obtiene la compensación de este Position dentro del elemento Text que muestra getSurroundingText() . |
insertBookmark() | Bookmark | Crea e inserta un nuevo Bookmark en este Position . |
insertInlineImage(image) | InlineImage | Crea e inserta un InlineImage nuevo en este Position desde el BLOB de imagen especificado. |
insertText(text) | Text | Inserta el texto especificado en esta Position . |
PositionedImage
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getAs(contentType) | Blob | Muestra los datos de este objeto como un BLOB convertido al tipo de contenido especificado. |
getBlob() | Blob | Muestra los datos dentro de este objeto como un BLOB. |
getHeight() | Integer | Recupera la altura de la imagen en píxeles. |
getId() | String | Obtiene el ID de la imagen. |
getLayout() | PositionedLayout | Obtiene un valor de enumeración que representa cómo se presenta la imagen. |
getLeftOffset() | Number | Obtiene el desplazamiento de la imagen, en puntos, desde la izquierda del párrafo. |
getParagraph() | Paragraph | Obtiene el Paragraph al que está anclada la imagen. |
getTopOffset() | Number | Obtiene el desplazamiento de la imagen, en puntos, desde la parte superior del párrafo. |
getWidth() | Integer | Recupera el ancho de la imagen, en píxeles. |
setHeight(height) | PositionedImage | Establece la altura de la imagen en píxeles. |
setLayout(layout) | PositionedImage | Establece la definición de la disposición de la imagen. |
setLeftOffset(offset) | PositionedImage | Establece el desplazamiento de la imagen, en puntos, desde la izquierda del párrafo. |
setTopOffset(offset) | PositionedImage | Establece el desplazamiento de la imagen, en puntos, desde la parte superior del párrafo. |
setWidth(width) | PositionedImage | Establece el ancho en píxeles de la imagen. |
PositionedLayout
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
ABOVE_TEXT | Enum | La imagen está ubicada sobre el texto. |
BREAK_BOTH | Enum | La imagen divide el texto a la izquierda y a la derecha. |
BREAK_LEFT | Enum | La imagen divide el texto a la izquierda. |
BREAK_RIGHT | Enum | La imagen divide el texto que se encuentra a la derecha. |
WRAP_TEXT | Enum | La imagen está envuelta en texto. |
Range
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getRangeElements() | RangeElement[] | Obtiene todos los elementos de este Range , incluidos los elementos parciales Text (por ejemplo, en el caso de una selección que incluye solo una parte de un elemento Text ). |
RangeBuilder
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addElement(element) | RangeBuilder | Agrega un Element completo a esta RangeBuilder . |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | Agrega un elemento Text parcial a este RangeBuilder . |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | Agrega dos elementos enteros, y todos los elementos entre ellos, a este RangeBuilder . |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | Agrega dos elementos Text parciales, y todos los elementos entre ellos, a RangeBuilder . |
addRange(range) | RangeBuilder | Agrega el contenido de otro Range a este RangeBuilder . |
build() | Range | Crea un Range a partir de la configuración aplicada al compilador. |
getRangeElements() | RangeElement[] | Obtiene todos los elementos de este Range , incluidos los elementos parciales Text (por ejemplo, en el caso de una selección que incluye solo una parte de un elemento Text ). |
RangeElement
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getElement() | Element | Obtiene el Element que corresponde a este RangeElement . |
getEndOffsetInclusive() | Integer | Obtiene la posición del final de un rango parcial dentro del elemento de rango. |
getStartOffset() | Integer | Obtiene la posición del inicio de un rango parcial dentro del elemento de rango. |
isPartial() | Boolean | Determina si este elemento de rango cubre todo el elemento o una selección parcial de sus caracteres. |
RichLink
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | RichLink | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getMimeType() | String | Muestra el tipo MIME del vínculo, que está disponible cuando el elemento es un vínculo a un archivo de Drive y, de lo contrario, null . |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getTitle() | String | Muestra el título que se muestra en el vínculo. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
getUrl() | String | Muestra la URL del recurso. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | RichLink | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | RichLink | Quita el elemento de su elemento superior. |
setAttributes(attributes) | RichLink | Establece los atributos del elemento. |
Table
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
appendTableRow() | TableRow | Crea y agrega un nuevo TableRow . |
appendTableRow(tableRow) | TableRow | Agrega el valor TableRow proporcionado. |
clear() | Table | Borra el contenido del elemento. |
copy() | Table | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getBorderColor() | String | Recupera el color del borde. |
getBorderWidth() | Number | Recupera el ancho del borde, en puntos. |
getCell(rowIndex, cellIndex) | TableCell | Recupera la TableCell en los índices de fila y celda especificados. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getColumnWidth(columnIndex) | Number | Recupera el ancho de la columna de la tabla especificada, en puntos. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getNumRows() | Integer | Recupera la cantidad de TableRows . |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getRow(rowIndex) | TableRow | Recupera la TableRow en el índice de fila especificado. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
insertTableRow(childIndex) | TableRow | Crea e inserta un nuevo TableRow en el índice especificado. |
insertTableRow(childIndex, tableRow) | TableRow | Inserta la TableRow especificada en el índice especificado. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
removeChild(child) | Table | Quita el elemento secundario especificado. |
removeFromParent() | Table | Quita el elemento de su elemento superior. |
removeRow(rowIndex) | TableRow | Quita el TableRow del índice de fila especificado. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | Table | Establece los atributos del elemento. |
setBorderColor(color) | Table | Establece el color del borde. |
setBorderWidth(width) | Table | Establece el ancho del borde en puntos. |
setColumnWidth(columnIndex, width) | Table | Establece el ancho de la columna especificada en puntos. |
setLinkUrl(url) | Table | Configura la URL del vínculo. |
setTextAlignment(textAlignment) | Table | Establece la alineación del texto. |
TableCell
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crea y agrega un nuevo HorizontalRule . |
appendImage(image) | InlineImage | Crea y agrega un InlineImage nuevo desde el BLOB de imagen especificado. |
appendImage(image) | InlineImage | Agrega el valor InlineImage proporcionado. |
appendListItem(listItem) | ListItem | Agrega el valor ListItem proporcionado. |
appendListItem(text) | ListItem | Crea y agrega un nuevo ListItem . |
appendParagraph(paragraph) | Paragraph | Agrega el valor Paragraph proporcionado. |
appendParagraph(text) | Paragraph | Crea y agrega un nuevo Paragraph . |
appendTable() | Table | Crea y agrega un nuevo Table . |
appendTable(cells) | Table | Agrega un nuevo Table que contenga las celdas especificadas. |
appendTable(table) | Table | Agrega el valor Table proporcionado. |
clear() | TableCell | Borra el contenido del elemento. |
copy() | TableCell | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getBackgroundColor() | String | Recupera el color de fondo. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getColSpan() | Integer | Recupera el intervalo de columnas, que es el número de columnas de celdas de la tabla que abarca esta celda. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getPaddingBottom() | Number | Recupera el relleno inferior, en puntos. |
getPaddingLeft() | Number | Recupera el relleno izquierdo, en puntos. |
getPaddingRight() | Number | Recupera el padding correcto, en puntos. |
getPaddingTop() | Number | Recupera el relleno superior, en puntos. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getParentRow() | TableRow | Recupera la TableRow que contiene la TableCell actual. |
getParentTable() | Table | Recupera la Table que contiene la TableCell actual. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getRowSpan() | Integer | Recupera el intervalo de filas, que es el número de filas de las celdas de la tabla que abarca esta celda. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
getVerticalAlignment() | VerticalAlignment | Recupera la VerticalAlignment . |
getWidth() | Number | Recupera el ancho de la columna que contiene la celda, en puntos. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea e inserta un nuevo HorizontalRule en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Crea e inserta un InlineImage del BLOB de imagen especificado, en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Inserta la InlineImage especificada en el índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Inserta la ListItem especificada en el índice especificado. |
insertListItem(childIndex, text) | ListItem | Crea e inserta un nuevo ListItem en el índice especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Inserta la Paragraph especificada en el índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Crea e inserta un nuevo Paragraph en el índice especificado. |
insertTable(childIndex) | Table | Crea e inserta un nuevo Table en el índice especificado. |
insertTable(childIndex, cells) | Table | Crea e inserta un nuevo objeto Table que contiene las celdas especificadas en el índice especificado. |
insertTable(childIndex, table) | Table | Inserta la Table especificada en el índice especificado. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | TableCell | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeChild(child) | TableCell | Quita el elemento secundario especificado. |
removeFromParent() | TableCell | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | TableCell | Establece los atributos del elemento. |
setBackgroundColor(color) | TableCell | Establece el color de fondo. |
setLinkUrl(url) | TableCell | Configura la URL del vínculo. |
setPaddingBottom(paddingBottom) | TableCell | Establece el padding de la parte inferior, en puntos. |
setPaddingLeft(paddingLeft) | TableCell | Establece el padding izquierdo, en puntos. |
setPaddingRight(paddingTop) | TableCell | Establece el padding correcto en puntos. |
setPaddingTop(paddingTop) | TableCell | Establece el padding superior, en puntos. |
setText(text) | TableCell | Establece el contenido como texto sin formato. |
setTextAlignment(textAlignment) | TableCell | Establece la alineación del texto. |
setVerticalAlignment(alignment) | TableCell | Establece la alineación vertical. |
setWidth(width) | TableCell | Establece el ancho de la columna que contiene la celda actual, en puntos. |
TableOfContents
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
clear() | TableOfContents | Borra el contenido del elemento. |
copy() | TableOfContents | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
removeFromParent() | TableOfContents | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | TableOfContents | Establece los atributos del elemento. |
setLinkUrl(url) | TableOfContents | Configura la URL del vínculo. |
setTextAlignment(textAlignment) | TableOfContents | Establece la alineación del texto. |
TableRow
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
appendTableCell() | TableCell | Crea y agrega un nuevo TableCell . |
appendTableCell(textContents) | TableCell | Agrega el valor TableCell especificado que contiene el texto especificado. |
appendTableCell(tableCell) | TableCell | Agrega el valor TableCell proporcionado. |
clear() | TableRow | Borra el contenido del elemento. |
copy() | TableRow | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findElement(elementType) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca el contenido del elemento para un descendiente del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getCell(cellIndex) | TableCell | Recupera la TableCell en el índice de celda especificado. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getMinimumHeight() | Number | Recupera la altura mínima en puntos. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getNumCells() | Integer | Recupera la cantidad de celdas de la fila. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getParentTable() | Table | Recupera la Table que contiene la fila actual. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
insertTableCell(childIndex) | TableCell | Crea e inserta un nuevo TableCell en el índice especificado. |
insertTableCell(childIndex, textContents) | TableCell | Inserta el TableCell especificado en el índice especificado, que contiene el texto dado. |
insertTableCell(childIndex, tableCell) | TableCell | Inserta la TableCell especificada en el índice especificado. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | TableRow | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeCell(cellIndex) | TableCell | Quita el TableCell del índice de celda especificado. |
removeChild(child) | TableRow | Quita el elemento secundario especificado. |
removeFromParent() | TableRow | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | TableRow | Establece los atributos del elemento. |
setLinkUrl(url) | TableRow | Configura la URL del vínculo. |
setMinimumHeight(minHeight) | TableRow | Establece la altura mínima, en puntos. |
setTextAlignment(textAlignment) | TableRow | Establece la alineación del texto. |
Text
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
appendText(text) | Text | Agrega el texto especificado al final de esta región de texto. |
copy() | Text | Muestra una copia profunda y separada del elemento actual. |
deleteText(startOffset, endOffsetInclusive) | Text | Borra un rango de texto. |
editAsText() | Text | Obtiene una versión Text del elemento actual para edición. |
findText(searchPattern) | RangeElement | Busca expresiones en el contenido del elemento según el patrón de texto especificado. |
findText(searchPattern, from) | RangeElement | Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getAttributes(offset) | Object | Recupera los atributos en el desplazamiento de caracteres especificado. |
getBackgroundColor() | String | Recupera la configuración de color del fondo. |
getBackgroundColor(offset) | String | Recupera el color de fondo del desplazamiento de caracteres especificado. |
getFontFamily() | String | Recupera la configuración de familia de fuentes. |
getFontFamily(offset) | String | Recupera la familia de fuentes en el desplazamiento de caracteres especificado. |
getFontSize() | Number | Recupera la configuración del tamaño de la fuente. |
getFontSize(offset) | Number | Recupera el tamaño de la fuente con el desplazamiento de caracteres especificado. |
getForegroundColor() | String | Recupera la configuración de color del primer plano. |
getForegroundColor(offset) | String | Recupera el color del primer plano en el desplazamiento de caracteres especificado. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getLinkUrl(offset) | String | Recupera la URL del vínculo en la compensación de caracteres especificada. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getTextAlignment(offset) | TextAlignment | Obtiene la alineación del texto para un solo carácter. |
getTextAttributeIndices() | Integer[] | Recupera el conjunto de índices de texto que corresponden al inicio de distintas ejecuciones de formato de texto. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
insertText(offset, text) | Text | Inserta el texto especificado en el desplazamiento de caracteres determinado. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
isBold() | Boolean | Recupera la configuración de negrita. |
isBold(offset) | Boolean | Recupera la configuración de negrita del desplazamiento de caracteres especificado. |
isItalic() | Boolean | Recupera la configuración de la cursiva. |
isItalic(offset) | Boolean | Recupera la configuración de cursiva en la compensación de caracteres especificada. |
isStrikethrough() | Boolean | Recupera la configuración de tachado. |
isStrikethrough(offset) | Boolean | Recupera la configuración de tachado en el desplazamiento de caracteres especificado. |
isUnderline() | Boolean | Recupera la configuración de subrayado. |
isUnderline(offset) | Boolean | Recupera la configuración de subrayado con el desplazamiento de caracteres especificado. |
merge() | Text | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | Text | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todas las apariciones de un patrón de texto dado con una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(startOffset, endOffsetInclusive, attributes) | Text | Aplica los atributos especificados al rango de caracteres determinado. |
setAttributes(attributes) | Text | Establece los atributos del elemento. |
setBackgroundColor(startOffset, endOffsetInclusive, color) | Text | Establece el color de fondo para el rango de caracteres especificado. |
setBackgroundColor(color) | Text | Establece el color de fondo. |
setBold(bold) | Text | Establece la configuración de negrita. |
setBold(startOffset, endOffsetInclusive, bold) | Text | Establece la configuración de negrita para el rango de caracteres especificado. |
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName) | Text | Configura la familia de fuentes del rango de caracteres especificado. |
setFontFamily(fontFamilyName) | Text | Establece la familia de fuentes. |
setFontSize(startOffset, endOffsetInclusive, size) | Text | Establece el tamaño de fuente para el rango de caracteres especificado. |
setFontSize(size) | Text | Establece el tamaño de la fuente. |
setForegroundColor(startOffset, endOffsetInclusive, color) | Text | Establece el color de primer plano para el rango de caracteres especificado. |
setForegroundColor(color) | Text | Establece el color de primer plano. |
setItalic(italic) | Text | Establece la configuración de cursiva. |
setItalic(startOffset, endOffsetInclusive, italic) | Text | Establece la configuración de cursiva para el rango de caracteres especificado. |
setLinkUrl(startOffset, endOffsetInclusive, url) | Text | Establece la URL del vínculo para el rango de caracteres especificado. |
setLinkUrl(url) | Text | Configura la URL del vínculo. |
setStrikethrough(strikethrough) | Text | Establece la configuración de tachado. |
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) | Text | Establece la configuración de tachado para el rango de caracteres especificado. |
setText(text) | Text | Establece el contenido del texto. |
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) | Text | Establece la alineación del texto para un rango de caracteres determinado. |
setTextAlignment(textAlignment) | Text | Establece la alineación del texto. |
setUnderline(underline) | Text | Establece la configuración de subrayado. |
setUnderline(startOffset, endOffsetInclusive, underline) | Text | Establece la configuración de subrayado del rango de caracteres especificado. |
TextAlignment
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
NORMAL | Enum | Alineación de texto normal. |
SUPERSCRIPT | Enum | Alineación de texto del superíndice. |
SUBSCRIPT | Enum | Alineación de texto del subíndice. |
UnsupportedElement
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | UnsupportedElement | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getNextSibling() | Element | Recupera el siguiente elemento secundario del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el objeto ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | UnsupportedElement | Combina el elemento con el elemento hermano anterior del mismo tipo. |
removeFromParent() | UnsupportedElement | Quita el elemento de su elemento superior. |
setAttributes(attributes) | UnsupportedElement | Establece los atributos del elemento. |
VerticalAlignment
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
BOTTOM | Enum | Opción de alineación inferior. |
CENTER | Enum | Opción de alineación central. |
TOP | Enum | Opción de alineación superior. |