Un elemento que representa una sección de pie de página. Por lo general, un Document
contiene como máximo un FooterSection
. FooterSection
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 a partir del BLOB de imagen especificado. |
appendImage(image) | InlineImage | Agrega el InlineImage especificado. |
appendListItem(listItem) | ListItem | Agrega el ListItem especificado. |
appendListItem(text) | ListItem | Crea y agrega un ListItem nuevo con el contenido de texto especificado. |
appendParagraph(paragraph) | Paragraph | Agrega el Paragraph especificado. |
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 un Table nuevo que contenga un TableCell para cada valor de string especificado. |
appendTable(table) | Table | Agrega el Table especificado. |
clear() | FooterSection | Borra el contenido del elemento. |
copy() | FooterSection | Muestra una copia independiente y profunda del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para editarla. |
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 en el contenido del elemento el patrón de texto especificado mediante expresiones regulares. |
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 para el 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 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 a partir del BLOB de imagen especificado, en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Inserta el InlineImage determinado en el índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Inserta el ListItem determinado en el índice especificado. |
insertListItem(childIndex, text) | ListItem | Crea e inserta un nuevo ListItem en el índice especificado, que incluye el contenido de texto especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Inserta el Paragraph determinado en el índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Crea e inserta un nuevo Paragraph en el índice especificado, que incluye 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 Table nuevo que contiene las celdas especificadas en el índice especificado. |
insertTable(childIndex, table) | Table | Inserta el Table determinado 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 ocurrencias 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. |
Documentación detallada
appendHorizontalRule()
Crea y agrega un HorizontalRule
nuevo.
El HorizontalRule
estará contenido en un nuevo Paragraph
.
Volver
HorizontalRule
: 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 a partir del BLOB de imagen especificado.
La imagen se incluirá en una nueva Paragraph
.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
image | BlobSource | los datos de la imagen |
Volver
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
especificado.
El InlineImage
estará contenido en un nuevo Paragraph
.
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 |
Volver
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
especificado.
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á |
Volver
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 la lista se agregan como parte de la misma lista.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | el contenido de texto del elemento de la lista |
Volver
ListItem
: Es el elemento de lista nuevo.
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
especificado.
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 adjuntar |
Volver
Paragraph
: es 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 del texto del párrafo |
Volver
Paragraph
: 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 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.
Volver
Table
: 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(cells)
Agrega un Table
nuevo que contenga 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 tabla nueva |
Volver
Table
: 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
especificado.
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 que se agregará |
Volver
Table
: 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 independiente y profunda del elemento actual.
También se copiarán todos los elementos secundarios que contenga. El nuevo elemento no tiene un elemento principal.
Volver
FooterSection
: 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Obtiene una versión Text
del elemento actual para editarla.
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 que se encuentran dentro de un rango de texto eliminado 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);
Volver
Text
: Es una versión de texto del elemento actual.
findElement(elementType)
Busca el contenido del elemento para un descendiente del tipo especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
elementType | ElementType | el tipo de elemento que se buscará |
Volver
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 el contenido del elemento para un descendiente 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 |
Volver
RangeElement
: Es un resultado de la búsqueda que indica la siguiente posición del elemento de la 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 que se buscará |
Volver
RangeElement
: Es un resultado de la búsqueda que indica la posición del texto de la búsqueda, o bien un valor nulo si no coincide.
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 el contenido del elemento para el patrón de texto especificado a partir de un resultado de 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 que se buscará |
from | RangeElement | el resultado de la búsqueda |
Volver
RangeElement
: Es un resultado de la búsqueda que indica la siguiente posición del texto de la búsqueda, o bien un valor nulo si no coincide.
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]); }
Volver
Object
: 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 que se debe recuperar |
Volver
Element
: 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 |
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getImages()
Recupera todos los InlineImages
contenidos en la sección.
Volver
InlineImage[]
: Las imágenes de 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
contenidos en la sección.
Volver
ListItem[]
: 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 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.");
Volver
Integer
: la cantidad de niños
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
contenidos en la sección (incluido ListItems
).
Volver
Paragraph[]
: 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 principal contiene el elemento actual.
Volver
ContainerElement
: Es el elemento principal.
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
contenidos en la sección.
Volver
Table[]
: las tablas de 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
getText()
Recupera el contenido del elemento como una string de texto.
Volver
String
: El contenido del elemento como string 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
.
Volver
TextAlignment
: 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.
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.'); }
Volver
ElementType
: 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 e inserta un nuevo HorizontalRule
en el índice especificado.
El HorizontalRule
estará contenido en un nuevo Paragraph
.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se inserta el elemento |
Volver
HorizontalRule
: 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 e inserta un InlineImage
a partir del BLOB de imagen especificado, en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se inserta el elemento |
image | BlobSource | los datos de la imagen |
Volver
InlineImage
: 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
Inserta el InlineImage
determinado en el índice especificado.
La imagen se incluirá en una nueva Paragraph
.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se inserta el elemento |
image | InlineImage | la imagen que se insertará |
Volver
InlineImage
: 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
Inserta el 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á |
Volver
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 e inserta un nuevo ListItem
en el índice especificado, que incluye el contenido de texto especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
text | String | el contenido de texto del elemento de la lista |
Volver
ListItem
: Es el elemento de lista nuevo.
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 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 |
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
Crea e inserta un nuevo Paragraph
en el índice especificado, que incluye el contenido de texto especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
text | String | el contenido del texto del párrafo |
Volver
Paragraph
: 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex)
Crea e inserta un nuevo Table
en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
Volver
Table
: 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
Crea e inserta un Table
nuevo 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 tabla nueva |
Volver
Table
: 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 alcances:
-
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 |
---|---|---|
childIndex | 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 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 que se desea quitar |
Volver
FooterSection
: 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(); }
Volver
FooterSection
: 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 todas las ocurrencias de un patrón de texto dado con una string de reemplazo determinada, mediante expresiones regulares.
El patrón de búsqueda se pasa como una string, no como un objeto de expresión regular de JavaScript. Debido a esto, deberás escapar cualquier barra invertida 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 que se 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 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 especificado debe ser un objeto en el que cada nombre de propiedad sea un elemento en 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. |
Volver
FooterSection
: 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 elimina el contenido existente.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | el nuevo contenido de texto |
Volver
FooterSection
: 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 del texto que se aplicará |
Volver
FooterSection
: 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