Elemento que representa una sección de encabezado. Por lo general, una Document
contiene un HeaderSection
como máximo. HeaderSection
puede contener elementos ListItem
, Paragraph
y Table
. Si deseas obtener más información sobre la estructura de los documentos, consulta la guía para extender Documentos de Google.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crea y agrega un HorizontalRule nuevo. |
appendImage(image) | InlineImage | Crea y agrega un InlineImage nuevo desde el BLOB de imágenes especificado. |
appendImage(image) | InlineImage | Agrega el InlineImage determinado. |
appendListItem(listItem) | ListItem | Agrega el ListItem determinado. |
appendListItem(text) | ListItem | Crea y agrega un ListItem nuevo con el contenido de texto especificado. |
appendParagraph(paragraph) | Paragraph | Agrega el Paragraph determinado. |
appendParagraph(text) | Paragraph | Crea y agrega un Paragraph nuevo con el contenido de texto especificado. |
appendTable() | Table | Crea y agrega un Table nuevo. |
appendTable(cells) | Table | Agrega una Table nueva que contiene un TableCell para cada valor de string especificado. |
appendTable(table) | Table | Agrega el Table determinado. |
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 editarlo. |
findElement(elementType) | RangeElement | Busca en el contenido del elemento un elemento subordinado del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca en el contenido del elemento un elemento subordinado del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca en el contenido del elemento el patrón de texto especificado mediante expresiones regulares. |
findText(searchPattern, from) | RangeElement | Busca en el contenido del elemento el patrón de texto especificado a partir de un resultado de la 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 para el elemento secundario especificado. |
getImages() | InlineImage[] | Recupera todos los InlineImages que se encuentran en la sección. |
getListItems() | ListItem[] | Recupera todos los ListItems que se encuentran en la sección. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParagraphs() | Paragraph[] | Recupera todos los Paragraphs que se incluyen en la sección (incluido ListItems ). |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getTables() | Table[] | Recupera todos los Tables que se encuentran 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 ElementType del elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea y, luego, inserta un nuevo HorizontalRule en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Crea y, luego, inserta un InlineImage desde el BLOB de imágenes especificado en el índice indicado. |
insertImage(childIndex, image) | InlineImage | Inserta el elemento InlineImage determinado en el índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Inserta el elemento ListItem determinado en el índice especificado. |
insertListItem(childIndex, text) | ListItem | Crea y, luego, inserta un ListItem nuevo en el índice especificado, que contiene los contenidos de texto especificados. |
insertParagraph(childIndex, paragraph) | Paragraph | Inserta el elemento Paragraph determinado en el índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Crea y, luego, inserta un Paragraph nuevo en el índice especificado, que contiene los contenidos de texto especificados. |
insertTable(childIndex) | Table | Crea y, luego, inserta un nuevo Table en el índice especificado. |
insertTable(childIndex, cells) | Table | Crea y, luego, inserta un nuevo Table que contiene las celdas especificadas en el índice especificado. |
insertTable(childIndex, table) | Table | Inserta el elemento Table determinado 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 todos los casos de un patrón de texto determinado por 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. |
Documentación detallada
appendHorizontalRule()
Crea y agrega un HorizontalRule
nuevo.
El HorizontalRule
se incluirá en un Paragraph
nuevo.
Devolvedor
HorizontalRule
: Es la nueva regla horizontal.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
Crea y agrega un InlineImage
nuevo desde el BLOB de imágenes especificado.
La imagen estará contenida en un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
image | BlobSource | los datos de la imagen |
Devolvedor
InlineImage
: Es la imagen adjunta.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
Agrega el InlineImage
determinado.
El InlineImage
se incluirá en un Paragraph
nuevo.
Usa esta versión de appendImage
cuando agregues una copia de un InlineImage
existente.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
image | InlineImage | los datos de la imagen |
Devolvedor
InlineImage
: Es la imagen adjunta.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
Agrega el ListItem
determinado.
Usa esta versión de appendListItem
cuando agregues una copia de un ListItem
existente.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
listItem | ListItem | el elemento de la lista que se agregará |
Devolvedor
ListItem
: Es el elemento de lista adjunto.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(text)
Crea y agrega un ListItem
nuevo con el contenido de texto especificado.
Los elementos consecutivos de una lista se agregan como parte de la misma lista.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | el contenido de texto del elemento de lista |
Devolvedor
ListItem
: Es el nuevo elemento de lista.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(paragraph)
Agrega el Paragraph
determinado.
Usa esta versión de appendParagraph
cuando agregues una copia de un Paragraph
existente.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
paragraph | Paragraph | el párrafo para anexar |
Devolvedor
Paragraph
: El párrafo adjunto
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(text)
Crea y agrega un Paragraph
nuevo con el contenido de texto especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | el contenido de texto del párrafo |
Devolvedor
Paragraph
: Es el nuevo párrafo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable()
Crea y agrega un Table
nuevo.
Este método también agregará un párrafo vacío después de la tabla, ya que los documentos de Documentos de Google no pueden terminar con una tabla.
Devolvedor
Table
: La nueva tabla
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(cells)
Agrega una Table
nueva que contiene un TableCell
para cada valor de string especificado.
Este método también agregará un párrafo vacío después de la tabla, ya que los documentos de Documentos de Google no pueden terminar con una tabla.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
cells | String[][] | el contenido de texto de las celdas de la tabla para agregar a la nueva tabla |
Devolvedor
Table
: Es la tabla adjunta.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(table)
Agrega el Table
determinado.
Usa esta versión de appendTable
cuando agregues una copia de un Table
existente.
Este método también agregará un párrafo vacío después de la tabla, ya que los documentos de Documentos de Google no pueden terminar con una tabla.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
table | Table | la tabla para adjuntar |
Devolvedor
Table
: Es la tabla adjunta.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Muestra una copia profunda y separada del elemento actual.
También se copian los elementos secundarios presentes en el elemento. El nuevo elemento no tiene un elemento superior.
Devolvedor
HeaderSection
: Es la nueva copia.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Obtiene una versión Text
del elemento actual para editarlo.
Usa editAsText
para manipular el contenido de los elementos como texto enriquecido. El modo editAsText
ignora los elementos que no son de texto (como InlineImage
y HorizontalRule
).
Los elementos secundarios completamente contenidos en un rango de texto borrado se quitan del elemento.
var body = DocumentApp.getActiveDocument().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Devolvedor
Text
: Es una versión de texto del elemento actual.
findElement(elementType)
Busca en el contenido del elemento un elemento subordinado del tipo especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
elementType | ElementType | el tipo de elemento que se buscará |
Devolvedor
RangeElement
: Es un resultado de la búsqueda que indica la posición del elemento de búsqueda.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Busca en el contenido del elemento un elemento subordinado del tipo especificado a partir del RangeElement
especificado.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
elementType | ElementType | el tipo de elemento que se buscará |
from | RangeElement | el resultado de la búsqueda desde |
Devolvedor
RangeElement
: Es un resultado de la búsqueda que indica la siguiente posición del elemento de búsqueda.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Busca en el contenido del elemento el patrón de texto especificado mediante expresiones regulares.
Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como los grupos de captura y los modificadores de modo.
El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
searchPattern | String | el patrón a buscar |
Devolvedor
RangeElement
: Es un resultado de la búsqueda que indica la posición del texto de búsqueda, o nulo si no hay una coincidencia.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Busca en el contenido del elemento el patrón de texto especificado a partir de un resultado de la búsqueda determinado.
Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como los grupos de captura y los modificadores de modo.
El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
searchPattern | String | el patrón a buscar |
from | RangeElement | el resultado de la búsqueda desde |
Devolvedor
RangeElement
: Es un resultado de la búsqueda que indica la siguiente posición del texto de búsqueda, o nulo si no hay una coincidencia.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
Recupera los atributos del elemento.
El resultado es un objeto que contiene una propiedad para cada atributo de elemento válido, en el que cada nombre de propiedad corresponde a un elemento en la enumeración DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Devolvedor
Object
: Son los atributos del elemento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Recupera el elemento secundario en el índice secundario especificado.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice del elemento secundario para recuperar |
Devolvedor
Element
: Es el elemento secundario en el índice especificado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
Recupera el índice secundario para el elemento secundario especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Element | el elemento secundario para el que se recupera el índice |
Devolvedor
Integer
: Es el índice secundario.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getImages()
Recupera todos los InlineImages
que se encuentran en la sección.
Devolvedor
InlineImage[]
: Son las imágenes de la sección.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListItems()
Recupera todos los ListItems
que se encuentran en la sección.
Devolvedor
ListItem[]
: Son los elementos de lista de secciones.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Recupera la cantidad de elementos secundarios.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Devolvedor
Integer
: Es la cantidad de elementos secundarios.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParagraphs()
Recupera todos los Paragraphs
que se incluyen en la sección (incluido ListItems
).
Devolvedor
Paragraph[]
: Son los párrafos de la sección.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Recupera el elemento principal del elemento.
El elemento superior contiene el elemento actual.
Devolvedor
ContainerElement
: Es el elemento superior.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTables()
Recupera todos los Tables
que se encuentran en la sección.
Devolvedor
Table[]
: Son las tablas de secciones.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
Recupera el contenido del elemento como una string de texto.
Devolvedor
String
: Es el contenido del elemento como una cadena de texto.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Obtiene la alineación del texto. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
y DocumentApp.TextAlignment.SUPERSCRIPT
.
Devolvedor
TextAlignment
: Es el tipo de alineación del texto, o null
si el texto contiene varios tipos de alineaciones de texto o si nunca se estableció la alineación del texto.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Recupera el ElementType
del elemento.
Usa getType()
para determinar el tipo exacto de un elemento determinado.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Devolvedor
ElementType
: Es el tipo de elemento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
Crea y, luego, inserta un nuevo HorizontalRule
en el índice especificado.
El HorizontalRule
se incluirá en un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
Devolvedor
HorizontalRule
: Es la nueva regla horizontal.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
Crea y, luego, inserta un InlineImage
desde el BLOB de imágenes especificado en el índice indicado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
image | BlobSource | los datos de la imagen |
Devolvedor
InlineImage
: Es la imagen intercalada insertada.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
Inserta el elemento InlineImage
determinado en el índice especificado.
La imagen estará contenida en un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
image | InlineImage | la imagen que se insertará |
Devolvedor
InlineImage
: Es la imagen intercalada insertada.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
Inserta el elemento ListItem
determinado en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
listItem | ListItem | el elemento de la lista que se insertará |
Devolvedor
ListItem
: Es el elemento de lista insertado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
Crea y, luego, inserta un ListItem
nuevo en el índice especificado, que contiene los contenidos de texto especificados.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
text | String | el contenido de texto del elemento de lista |
Devolvedor
ListItem
: Es el nuevo elemento de lista.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
Inserta el elemento Paragraph
determinado en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
paragraph | Paragraph | el párrafo para insertar |
Devolvedor
Paragraph
: Es el párrafo insertado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
Crea y, luego, inserta un Paragraph
nuevo en el índice especificado, que contiene los contenidos de texto especificados.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
text | String | el contenido de texto del párrafo |
Devolvedor
Paragraph
: Es el nuevo párrafo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex)
Crea y, luego, inserta un nuevo Table
en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
Devolvedor
Table
: La nueva tabla
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
Crea y, luego, inserta un nuevo Table
que contiene las celdas especificadas en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
cells | String[][] | el contenido de texto de las celdas de la tabla para agregar a la nueva tabla |
Devolvedor
Table
: La nueva tabla
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, table)
Inserta el elemento Table
determinado en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
table | Table | la tabla para insertar |
Devolvedor
Table
: Es la tabla insertada.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
Quita el elemento secundario especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Element | el elemento secundario quitar |
Devolvedor
HeaderSection
: Es el elemento actual.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Quita el elemento de su elemento superior.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Devolvedor
HeaderSection
: Es el elemento que se quitó.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
Reemplaza todos los casos de un patrón de texto determinado por una string de reemplazo determinada mediante expresiones regulares.
El patrón de búsqueda se pasa como una string y no como un objeto de expresión regular de JavaScript. Debido a esto, deberás escapar cualquier barra inversa en el patrón.
Este método usa la biblioteca de expresiones regulares RE2 de Google, que limita la sintaxis compatible.
El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
searchPattern | String | el patrón de regex para buscar |
replacement | String | el texto que se utilizará como reemplazo |
Devolvedor
Element
: Es el elemento actual.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Establece los atributos del elemento.
El parámetro de atributos especificados debe ser un objeto en el que cada nombre de propiedad sea un elemento de la enumeración DocumentApp.Attribute
y cada valor de propiedad sea el valor nuevo que se aplicará.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
attributes | Object | Los atributos del elemento. |
Devolvedor
HeaderSection
: Es el elemento actual.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
Establece el contenido como texto sin formato.
Nota: Se borra el contenido existente.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | el nuevo contenido de texto |
Devolvedor
HeaderSection
: Es el elemento actual.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
Establece la alineación del texto. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
y DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
textAlignment | TextAlignment | el tipo de alineación de texto que se aplicará |
Devolvedor
HeaderSection
: Es el elemento actual.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents