Es un elemento que representa una sección de encabezado. Por lo general, un Document
contiene como máximo un Header
. Header
puede contener elementos List
, Paragraph
y Table
. Para 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 |
---|---|---|
append | Horizontal | Crea y agrega una Horizontal nueva. |
append | Inline | Crea y agrega un Inline nuevo a partir del blob de imagen especificado. |
append | Inline | Agrega el Inline determinado. |
append | List | Agrega el List determinado. |
append | List | Crea y agrega un nuevo List que contiene el contenido de texto especificado. |
append | Paragraph | Agrega el Paragraph determinado. |
append | Paragraph | Crea y agrega un nuevo Paragraph que contiene el contenido de texto especificado. |
append | Table | Crea y agrega una Table nueva. |
append | Table | Adjunta un Table nuevo que contiene un Table para cada valor de cadena especificado. |
append | Table | Agrega el Table determinado. |
clear() | Header | Borra el contenido del elemento. |
copy() | Header | Muestra una copia profunda y separada del elemento actual. |
edit | Text | Obtiene una versión Text del elemento actual para editarlo. |
find | Range | Busca un descendiente del tipo especificado en el contenido del elemento. |
find | Range | Busca un descendiente del tipo especificado en el contenido del elemento, a partir del Range especificado. |
find | Range | Busca el patrón de texto especificado en el contenido del elemento con expresiones regulares. |
find | Range | Busca el patrón de texto especificado en el contenido del elemento, a partir de un resultado de búsqueda determinado. |
get | Object | Recupera los atributos del elemento. |
get | Element | Recupera el elemento secundario en el índice secundario especificado. |
get | Integer | Recupera el índice secundario del elemento secundario especificado. |
get | Inline | Recupera todos los Inline contenidos en la sección. |
get | List | Recupera todos los List contenidos en la sección. |
get | Integer | Recupera la cantidad de elementos secundarios. |
get | Paragraph[] | Recupera todos los Paragraphs contenidos en la sección (incluidos List ). |
get | Container | Recupera el elemento superior del elemento. |
get | Table[] | Recupera todos los Tables contenidos en la sección. |
get | String | Recupera el contenido del elemento como una cadena de texto. |
get | Text | Obtiene la alineación del texto. |
get | Element | Recupera el Element del elemento. |
insert | Horizontal | Crea y, luego, inserta un Horizontal nuevo en el índice especificado. |
insert | Inline | Crea e inserta un Inline a partir del blob de imagen especificado, en el índice especificado. |
insert | Inline | Inserta el Inline determinado en el índice especificado. |
insert | List | Inserta el List determinado en el índice especificado. |
insert | List | Crea e inserta un List nuevo en el índice especificado, que contiene el contenido de texto especificado. |
insert | Paragraph | Inserta el Paragraph determinado en el índice especificado. |
insert | Paragraph | Crea e inserta un Paragraph nuevo en el índice especificado, que contiene el contenido de texto especificado. |
insert | Table | Crea y, luego, inserta un Table nuevo en el índice especificado. |
insert | Table | Crea e inserta un nuevo Table que contiene las celdas especificadas en el índice especificado. |
insert | Table | Inserta el Table determinado en el índice especificado. |
remove | Header | Quita el elemento secundario especificado. |
remove | Header | Quita el elemento de su elemento superior. |
replace | Element | Reemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada con expresiones regulares. |
set | Header | Establece los atributos del elemento. |
set | Header | Establece el contenido como texto sin formato. |
set | Header | Establece la alineación del texto. |
Métodos obsoletos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
| Footnote[] | Recupera todos los Footnotes contenidos en la sección. |
| String | Recupera la URL del vínculo. |
| Element | Recupera el siguiente elemento hermano del elemento. |
| Element | Recupera el elemento hermano anterior del elemento. |
| Boolean | Determina si el elemento está al final de Document . |
| Header | Establece la URL del vínculo. |
Documentación detallada
appendHorizontalRule()
Crea y agrega una Horizontal
nueva.
El Horizontal
se contendrá en un Paragraph
nuevo.
Volver
Horizontal
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
Crea y agrega un Inline
nuevo a partir del blob de imagen especificado.
La imagen se contendrá en un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
image | Blob | Los datos de la imagen. |
Volver
Inline
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
Agrega el Inline
determinado.
El Inline
se contendrá en un Paragraph
nuevo.
Usa esta versión de append
cuando adjuntes una copia de un Inline
existente.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
image | Inline | Los datos de la imagen. |
Volver
Inline
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
Agrega el List
determinado.
Usa esta versión de append
cuando adjuntes una copia de un List
existente.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
list | List | Es el elemento de la lista que se agregará. |
Volver
List
: Es el elemento de lista agregado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(text)
Crea y agrega un nuevo List
que contiene el contenido de texto especificado.
Los elementos de lista consecutivos se agregan como parte de la misma lista.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | Es el contenido de texto del elemento de lista. |
Volver
List
: Es el nuevo elemento de la lista.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(paragraph)
Agrega el Paragraph
determinado.
Usa esta versión de append
cuando adjuntes una copia de un Paragraph
existente.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
paragraph | Paragraph | Es el párrafo que se agregará. |
Volver
Paragraph
: Es el párrafo agregado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(text)
Crea y agrega un nuevo Paragraph
que contiene el contenido de texto especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | Es el contenido de texto del párrafo. |
Volver
Paragraph
: Es el párrafo nuevo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable()
Crea y agrega una Table
nueva.
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.
Volver
Table
: Es la tabla nueva.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(cells)
Adjunta un Table
nuevo que contiene un Table
para cada valor de cadena 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[][] | Es el contenido de texto de las celdas de la tabla que se agregará a la tabla nueva. |
Volver
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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(table)
Agrega el Table
determinado.
Usa esta versión de append
cuando adjuntes 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 que se anexará. |
Volver
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 ámbitos:
-
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 elemento nuevo no tiene un elemento superior.
Volver
Header
: Es la copia nueva.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
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 edit
para manipular el contenido de los elementos como texto enriquecido. El modo edit
ignora los elementos no textuales (como Inline
y Horizontal
).
Los elementos secundarios que se encuentran completamente dentro de un rango de texto borrado se quitan del elemento.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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);
Volver
Text
: Es una versión de texto del elemento actual.
findElement(elementType)
Busca un descendiente del tipo especificado en el contenido del elemento.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
element | Element | Es el tipo de elemento que se busca. |
Volver
Range
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Busca un descendiente del tipo especificado en el contenido del elemento, a partir del Range
especificado.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
element | Element | Es el tipo de elemento que se busca. |
from | Range | El resultado de la búsqueda desde el que se realizará la búsqueda. |
Volver
Range
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Busca el patrón de texto especificado en el contenido del elemento con expresiones regulares.
Un subconjunto de las funciones de expresión regular de JavaScript no es completamente 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 que se encuentra en el elemento actual.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
search | String | el patrón que se busca |
Volver
Range
: Es un resultado de la búsqueda que indica la posición del texto de la búsqueda o un valor nulo si no hay coincidencias.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Busca el patrón de texto especificado en el contenido del elemento, a partir de un resultado de búsqueda determinado.
Un subconjunto de las funciones de expresión regular de JavaScript no es completamente 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 que se encuentra en el elemento actual.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
search | String | el patrón que se busca |
from | Range | el resultado de la búsqueda desde el que se realizará la búsqueda |
Volver
Range
: Es un resultado de la búsqueda que indica la siguiente posición del texto de la búsqueda o un valor nulo si no hay coincidencias.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
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 de la enumeración Document
.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
Volver
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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Recupera el elemento secundario en el índice secundario especificado.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const 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 |
---|---|---|
child | Integer | Es el índice del elemento secundario que se recuperará. |
Volver
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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
Recupera el índice secundario del elemento secundario especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Element | Es el elemento secundario para el que se debe recuperar el índice. |
Volver
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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getImages()
Recupera todos los Inline
contenidos en la sección.
Volver
Inline
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListItems()
Recupera todos los List
contenidos en la sección.
Volver
List
: Son los elementos de la 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Recupera la cantidad de elementos secundarios.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
Volver
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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParagraphs()
Recupera todos los Paragraphs
contenidos en la sección (incluidos List
).
Volver
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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Recupera el elemento superior del elemento.
El elemento superior contiene el elemento actual.
Volver
Container
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTables()
Recupera todos los Tables
contenidos en la sección.
Volver
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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
Recupera el contenido del elemento como una cadena de texto.
Volver
String
: Es el contenido del elemento como 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 ámbitos:
-
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 Document
, Document
y Document
.
Volver
Text
: Es el tipo de alineación de texto, o null
si el texto contiene varios tipos de alineaciones de texto o si nunca se configuró la alineación de texto.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Recupera el Element
del elemento.
Usa get
para determinar el tipo exacto de un elemento determinado.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const 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.'); }
Volver
Element
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
Crea y, luego, inserta un Horizontal
nuevo en el índice especificado.
El Horizontal
se contendrá en un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Integer | Es el índice en el que se inserta el elemento. |
Volver
Horizontal
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
Crea e inserta un Inline
a partir del blob de imagen especificado, en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Integer | Es el índice en el que se inserta el elemento. |
image | Blob | Los datos de la imagen. |
Volver
Inline
: Es la imagen intercalada que se insertó.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
Inserta el Inline
determinado en el índice especificado.
La imagen se contendrá en un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Integer | Es el índice en el que se inserta el elemento. |
image | Inline | La imagen que se va a insertar. |
Volver
Inline
: Es la imagen intercalada que se insertó.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
Inserta el List
determinado en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Integer | El índice en el que se insertará. |
list | List | Es el elemento de la lista que se insertará. |
Volver
List
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
Crea e inserta un List
nuevo en el índice especificado, que contiene el contenido de texto especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Integer | El índice en el que se insertará. |
text | String | Es el contenido de texto del elemento de lista. |
Volver
List
: Es el nuevo elemento de la lista.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
Inserta el Paragraph
determinado en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Integer | El índice en el que se insertará. |
paragraph | Paragraph | Es el párrafo que se insertará. |
Volver
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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
Crea e inserta un Paragraph
nuevo en el índice especificado, que contiene el contenido de texto especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Integer | El índice en el que se insertará. |
text | String | Es el contenido de texto del párrafo. |
Volver
Paragraph
: Es el párrafo nuevo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex)
Crea y, luego, inserta un Table
nuevo en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Integer | El índice en el que se insertará. |
Volver
Table
: Es la tabla nueva.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
Crea e inserta un nuevo Table
que contiene las celdas especificadas en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Integer | El índice en el que se insertará. |
cells | String[][] | Es el contenido de texto de las celdas de la tabla que se agregará a la tabla nueva. |
Volver
Table
: Es la tabla nueva.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, table)
Inserta el Table
determinado en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Integer | El índice en el que se insertará. |
table | Table | La tabla que se insertará. |
Volver
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 ámbitos:
-
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 | Es el elemento secundario que se quitará. |
Volver
Header
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Quita el elemento de su elemento superior.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Volver
Header
: 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 ámbitos:
-
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 cadena de reemplazo determinada con expresiones regulares.
El patrón de búsqueda se pasa como una cadena, no como un objeto de expresión regular de JavaScript. Por lo tanto, deberás escapar las barras inversas del patrón.
Este método usa la biblioteca de expresiones regulares RE2 de Google, que limita la sintaxis admitida.
El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto que se encuentra en el elemento actual.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
search | String | el patrón de regex que se debe buscar |
replacement | String | el texto que se usará como reemplazo |
Volver
Element
: 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 ámbitos:
-
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 especificado debe ser un objeto en el que cada nombre de propiedad sea un elemento de la enumeración Document
y cada valor de propiedad sea el valor nuevo que se aplicará.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const 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. const 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 |
Volver
Header
: 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 ámbitos:
-
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 |
Volver
Header
: 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 ámbitos:
-
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 Document
, Document
y Document
.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | Text | el tipo de alineación de texto que se aplicará |
Volver
Header
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
Métodos obsoletos
getFootnotes()
getFootnotes()
Obsoleto. Este elemento no puede contener un Footnote
.
Recupera todos los Footnotes
contenidos en la sección.
Volver
Footnote[]
: Son las notas al pie 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
getLinkUrl()
Obsoleto. En lugar de aplicar un vínculo a una sección completa, aplícalo a un elemento dentro de la sección.
Recupera la URL del vínculo.
Volver
String
: Es la URL del vínculo o un valor nulo si el elemento contiene varios valores para este atributo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
getNextSibling()
Obsoleto. Este elemento no tiene elementos hermanos.
Recupera el siguiente elemento hermano del elemento.
El siguiente hermano tiene el mismo elemento superior y sigue al elemento actual.
Volver
Element
: Es el siguiente elemento hermano.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
getPreviousSibling()
Obsoleto. Este elemento no tiene elementos hermanos.
Recupera el elemento hermano anterior del elemento.
El hermano anterior tiene el mismo elemento superior y precede al elemento actual.
Volver
Element
: Es el elemento hermano anterior.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
isAtDocumentEnd()
Obsoleto. Este método no es confiable para Header
.
Determina si el elemento está al final de Document
.
Volver
Boolean
: Indica si el elemento está al final de la pestaña.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
setLinkUrl(url)
Obsoleto. En lugar de aplicar un vínculo a una sección completa, aplícalo a un elemento dentro de la sección.
Establece la URL del vínculo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
url | String | la URL del vínculo |
Volver
Header
: 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 ámbitos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents