Class Text

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.
Texto

Un elemento que representa una región de texto enriquecido. Todo el texto de un Document se encuentra dentro de elementos Text. Un elemento Text puede estar dentro de un Equation, EquationFunction, ListItem o Paragraph, pero no puede contener ningún otro elemento. Si deseas obtener más información sobre la estructura de los documentos, consulta la guía para extender Documentos de Google.

var body = DocumentApp.getActiveDocument().getBody();

// Use editAsText to obtain a single text element containing
// all the characters in the document.
var text = body.editAsText();

// Insert text at the beginning of the document.
text.insertText(0, 'Inserted text.\n');

// Insert text at the end of the document.
text.appendText('\nAppended text.');

// Make the first half of the document blue.
text.setForegroundColor(0, text.getText().length / 2, '#00FFFF');

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendText(text)TextAgrega el texto especificado al final de esta región de texto.
copy()TextMuestra una copia independiente y profunda del elemento actual.
deleteText(startOffset, endOffsetInclusive)TextBorra un rango de texto.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findText(searchPattern)RangeElementBusca en el contenido del elemento el patrón de texto especificado mediante expresiones regulares.
findText(searchPattern, from)RangeElementBusca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getAttributes(offset)ObjectRecupera los atributos del desplazamiento de caracteres especificado.
getBackgroundColor()StringRecupera la configuración de color de fondo.
getBackgroundColor(offset)StringRecupera el color de fondo en el desplazamiento de caracteres especificado.
getFontFamily()StringRecupera la configuración de la familia de fuentes.
getFontFamily(offset)StringRecupera la familia de fuentes en el desplazamiento de caracteres especificado.
getFontSize()NumberRecupera la configuración de tamaño de fuente.
getFontSize(offset)NumberRecupera el tamaño de la fuente en el desplazamiento de caracteres especificado.
getForegroundColor()StringRecupera la configuración de color del primer plano.
getForegroundColor(offset)StringRecupera el color de primer plano en el desplazamiento de caracteres especificado.
getLinkUrl()StringRecupera la URL del vínculo.
getLinkUrl(offset)StringRecupera la URL del vínculo en el desplazamiento de caracteres especificado.
getNextSibling()ElementRecupera el siguiente elemento del mismo nivel del elemento.
getParent()ContainerElementRecupera el elemento principal del elemento.
getPreviousSibling()ElementRecupera el elemento del mismo nivel anterior del elemento.
getText()StringRecupera el contenido del elemento como una string de texto.
getTextAlignment()TextAlignmentObtiene la alineación del texto.
getTextAlignment(offset)TextAlignmentObtiene la alineación del texto para un solo carácter.
getTextAttributeIndices()Integer[]Recupera el conjunto de índices de texto que corresponden al comienzo de distintas ejecuciones de formato de texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertText(offset, text)TextInserta el texto especificado en el desplazamiento de caracteres dado.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
isBold()BooleanRecupera la configuración de negrita.
isBold(offset)BooleanRecupera la configuración de negrita en el desplazamiento de caracteres especificado.
isItalic()BooleanRecupera la configuración de cursiva.
isItalic(offset)BooleanRecupera la configuración de cursiva en el desplazamiento de caracteres especificado.
isStrikethrough()BooleanRecupera la configuración de tachado.
isStrikethrough(offset)BooleanRecupera la configuración de tachado en el desplazamiento de caracteres especificado.
isUnderline()BooleanRecupera la configuración de subrayado.
isUnderline(offset)BooleanRecupera la configuración de subrayado con el desplazamiento de caracteres especificado.
merge()TextCombina el elemento con el elemento anterior del mismo tipo.
removeFromParent()TextQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todas las ocurrencias de un patrón de texto dado con una string de reemplazo determinada, mediante expresiones regulares.
setAttributes(startOffset, endOffsetInclusive, attributes)TextAplica los atributos especificados al rango de caracteres determinado.
setAttributes(attributes)TextEstablece los atributos del elemento.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextEstablece el color de fondo para el rango de caracteres especificado.
setBackgroundColor(color)TextEstablece el color de fondo.
setBold(bold)TextEstablece la configuración de negrita.
setBold(startOffset, endOffsetInclusive, bold)TextEstablece la configuración de negrita para el rango de caracteres especificado.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextEstablece la familia de fuentes del rango de caracteres especificado.
setFontFamily(fontFamilyName)TextEstablece la familia de fuentes.
setFontSize(startOffset, endOffsetInclusive, size)TextEstablece el tamaño de fuente del rango de caracteres especificado.
setFontSize(size)TextEstablece el tamaño de la fuente.
setForegroundColor(startOffset, endOffsetInclusive, color)TextEstablece el color de primer plano para el rango de caracteres especificado.
setForegroundColor(color)TextEstablece el color del primer plano.
setItalic(italic)TextEstablece la configuración de cursiva.
setItalic(startOffset, endOffsetInclusive, italic)TextEstablece la configuración de cursiva para el rango de caracteres especificado.
setLinkUrl(startOffset, endOffsetInclusive, url)TextEstablece la URL del vínculo para el rango de caracteres especificado.
setLinkUrl(url)TextEstablece la URL del vínculo.
setStrikethrough(strikethrough)TextEstablece la configuración de tachado.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextEstablece la configuración de tachado para el rango de caracteres especificado.
setText(text)TextEstablece el contenido del texto.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextEstablece la alineación del texto para un rango de caracteres determinado.
setTextAlignment(textAlignment)TextEstablece la alineación del texto.
setUnderline(underline)TextEstablece la configuración de subrayado.
setUnderline(startOffset, endOffsetInclusive, underline)TextEstablece la configuración de subrayado para el rango de caracteres especificado.

Documentación detallada

appendText(text)

Agrega el texto especificado al final de esta región de texto.

Parámetros

NombreTipoDescripción
textStringel texto que se agregará

Volver

Text: 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

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

Text: 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

deleteText(startOffset, endOffsetInclusive)

Borra un rango de texto.

Parámetros

NombreTipoDescripción
startOffsetIntegerel desplazamiento de caracteres del primer carácter que se borrará
endOffsetInclusiveIntegerel desplazamiento de caracteres del último carácter que se borrará

Volver

Text: 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

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.


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

NombreTipoDescripción
searchPatternStringel 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

NombreTipoDescripción
searchPatternStringel patrón que se buscará
fromRangeElementel 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

getAttributes(offset)

Recupera los atributos del desplazamiento de caracteres especificado.

El resultado es un objeto que contiene una propiedad para cada atributo de texto válido, en el que cada nombre de propiedad corresponde a un elemento en la enumeración DocumentApp.Attribute.

Parámetros

NombreTipoDescripción
offsetIntegercompensación de caracteres

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

getBackgroundColor()

Recupera la configuración de color de fondo.

Volver

String: El color de fondo, con formato en notación CSS (como '#ffffff') o 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 alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBackgroundColor(offset)

Recupera el color de fondo en el desplazamiento de caracteres especificado.

Parámetros

NombreTipoDescripción
offsetIntegercompensación de caracteres

Volver

String: El color de fondo, con formato en notación CSS (como '#ffffff')

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

getFontFamily()

Recupera la configuración de la familia de fuentes. El nombre puede ser cualquier fuente del menú Fuente en Documentos o Google Fonts, y distingue entre mayúsculas y minúsculas. Los métodos getFontFamily() y setFontFamily(fontFamilyName) ahora usan nombres de string para las fuentes en lugar de la enumeración FontFamily. Si bien esta enumeración es obsoleta, se mantendrá su compatibilidad con las secuencias de comandos más antiguas.

Volver

String: Es la familia de fuentes, o bien 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 alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFontFamily(offset)

Recupera la familia de fuentes en el desplazamiento de caracteres especificado. El nombre puede ser cualquier fuente del menú Fuente en Documentos o Google Fonts, y distingue entre mayúsculas y minúsculas. Los métodos getFontFamily() y setFontFamily(fontFamilyName) ahora usan nombres de string para las fuentes en lugar de la enumeración FontFamily. Si bien esta enumeración es obsoleta, se mantendrá su compatibilidad con las secuencias de comandos más antiguas.

Parámetros

NombreTipoDescripción
offsetIntegercompensación de caracteres

Volver

String: la familia de fuentes

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

getFontSize()

Recupera la configuración de tamaño de fuente.

Volver

Number: Es el tamaño de fuente o 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 alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFontSize(offset)

Recupera el tamaño de la fuente en el desplazamiento de caracteres especificado.

Parámetros

NombreTipoDescripción
offsetIntegercompensación de caracteres

Volver

Number: El tamaño de la fuente

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

getForegroundColor()

Recupera la configuración de color del primer plano.

Volver

String: Es el color de primer plano, con formato en la notación CSS (como '#ffffff') o 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 alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getForegroundColor(offset)

Recupera el color de primer plano en el desplazamiento de caracteres especificado.

Parámetros

NombreTipoDescripción
offsetIntegercompensación de caracteres

Volver

String: Es el color de primer plano, con formato en notación CSS (como '#ffffff').

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

getLinkUrl()

Recupera la URL del vínculo.

Volver

String: Es la URL del vínculo, o bien 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 alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getLinkUrl(offset)

Recupera la URL del vínculo en el desplazamiento de caracteres especificado.

Parámetros

NombreTipoDescripción
offsetIntegercompensación de caracteres

Volver

String: Es la URL del vínculo.

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

getNextSibling()

Recupera el siguiente elemento del mismo nivel del elemento.

El siguiente elemento del mismo nivel tiene el mismo elemento principal y sigue el elemento actual.

Volver

Element: el siguiente elemento del mismo nivel.

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

getPreviousSibling()

Recupera el elemento del mismo nivel anterior del elemento.

El elemento anterior tiene el mismo elemento principal y precede al elemento actual.

Volver

Element: el elemento del mismo nivel anterior.

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

getTextAlignment(offset)

Obtiene la alineación del texto para un solo carácter. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT y DocumentApp.TextAlignment.SUPERSCRIPT.

Parámetros

NombreTipoDescripción
offsetIntegerla compensación del carácter

Volver

TextAlignment: Es el tipo de alineación del texto o null si la alineación del texto nunca se estableció.

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

getTextAttributeIndices()

Recupera el conjunto de índices de texto que corresponden al comienzo de distintas ejecuciones de formato de texto.

Volver

Integer[]: Es el conjunto de índices de texto en los que cambia el formato 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.');
}

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

insertText(offset, text)

Inserta el texto especificado en el desplazamiento de caracteres dado.

Parámetros

NombreTipoDescripción
offsetIntegerel desplazamiento de caracteres en el que se insertará
textStringel texto que se insertará

Volver

Text: 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

isAtDocumentEnd()

Determina si el elemento está al final de Document.

Volver

Boolean: Indica si el elemento se encuentra al final del documento.

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

isBold()

Recupera la configuración de negrita.

Volver

Boolean: Si el texto está en negrita o es 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 alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

isBold(offset)

Recupera la configuración de negrita en el desplazamiento de caracteres especificado.

Parámetros

NombreTipoDescripción
offsetIntegercompensación de caracteres

Volver

Boolean: Es la configuración en negrita.

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

isItalic()

Recupera la configuración de cursiva.

Volver

Boolean: Si el texto está en cursiva o es 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 alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

isItalic(offset)

Recupera la configuración de cursiva en el desplazamiento de caracteres especificado.

Parámetros

NombreTipoDescripción
offsetIntegercompensación de caracteres

Volver

Boolean: Es la configuración de cursiva.

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

isStrikethrough()

Recupera la configuración de tachado.

Volver

Boolean: Si el texto está tachado o si es 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 alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

isStrikethrough(offset)

Recupera la configuración de tachado en el desplazamiento de caracteres especificado.

Parámetros

NombreTipoDescripción
offsetIntegercompensación de caracteres

Volver

Boolean: Es la configuración tachada.

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

isUnderline()

Recupera la configuración de subrayado.

Volver

Boolean: indica si el texto está subrayado o es 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 alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

isUnderline(offset)

Recupera la configuración de subrayado con el desplazamiento de caracteres especificado.

Parámetros

NombreTipoDescripción
offsetIntegercompensación de caracteres

Volver

Boolean: Es la configuración de subrayado.

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

merge()

Combina el elemento con el elemento anterior del mismo tipo.

Solo se pueden combinar elementos del mismo ElementType. Todos los elementos secundarios contenidos en el elemento actual se mueven al elemento del mismo nivel anterior.

El elemento actual se quita del documento.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

Volver

Text: el elemento combinado.

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

Text: 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

NombreTipoDescripción
searchPatternStringel patrón de regex que se buscará
replacementStringel 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(startOffset, endOffsetInclusive, attributes)

Aplica los atributos especificados al rango de caracteres determinado.

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á.

Parámetros

NombreTipoDescripción
startOffsetIntegerCompensación de inicio del rango de texto
endOffsetInclusiveIntegercompensación de finalización del intervalo de texto
attributesObjectlos atributos del elemento

Volver

Text: 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

NombreTipoDescripción
attributesObjectLos atributos del elemento.

Volver

Text: 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

setBackgroundColor(startOffset, endOffsetInclusive, color)

Establece el color de fondo para el rango de caracteres especificado.

Parámetros

NombreTipoDescripción
startOffsetIntegerCompensación de inicio del rango de texto
endOffsetInclusiveIntegercompensación de finalización del intervalo de texto
colorStringEl color de fondo, con formato en notación CSS (como '#ffffff').

Volver

Text: 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

setBackgroundColor(color)

Establece el color de fondo.

Parámetros

NombreTipoDescripción
colorStringEl color de fondo, con formato en notación CSS (como '#ffffff').

Volver

Text: 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

setBold(bold)

Establece la configuración de negrita.

Parámetros

NombreTipoDescripción
boldBooleanla configuración de negrita

Volver

Text: 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

setBold(startOffset, endOffsetInclusive, bold)

Establece la configuración de negrita para el rango de caracteres especificado.

Parámetros

NombreTipoDescripción
startOffsetIntegerCompensación de inicio del rango de texto
endOffsetInclusiveIntegercompensación de finalización del intervalo de texto
boldBooleanla configuración de negrita

Volver

Text: 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

setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)

Establece la familia de fuentes del rango de caracteres especificado. El nombre puede ser cualquier fuente del menú de fuentes en Documentos o Google Fonts, y distingue entre mayúsculas y minúsculas. Los nombres de fuentes no reconocidos se mostrarán como Arial. Los métodos getFontFamily(offset) y setFontFamily(fontFamilyName) ahora usan nombres de string para las fuentes en lugar de la enumeración FontFamily. Si bien esta enumeración es obsoleta, se mantendrá su compatibilidad con las secuencias de comandos más antiguas.

Parámetros

NombreTipoDescripción
startOffsetIntegerCompensación de inicio del rango de texto
endOffsetInclusiveIntegercompensación de finalización del intervalo de texto
fontFamilyNameStringel nombre de la familia de fuentes, desde el menú Fuente en Documentos o Google Fonts

Volver

Text: 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

setFontFamily(fontFamilyName)

Establece la familia de fuentes. El nombre puede ser cualquier fuente del menú Fuente en Documentos o Google Fonts, y distingue entre mayúsculas y minúsculas. Los nombres de fuentes no reconocidos se procesarán como Arial. Los métodos getFontFamily() y setFontFamily(fontFamilyName) ahora usan nombres de string para las fuentes en lugar de la enumeración FontFamily. Si bien esta enumeración es obsoleta, se mantendrá su compatibilidad con las secuencias de comandos más antiguas.

Parámetros

NombreTipoDescripción
fontFamilyNameStringel nombre de la familia de fuentes, desde el menú Fuente en Documentos o Google Fonts

Volver

Text: 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

setFontSize(startOffset, endOffsetInclusive, size)

Establece el tamaño de fuente del rango de caracteres especificado.

Parámetros

NombreTipoDescripción
startOffsetIntegerCompensación de inicio del rango de texto
endOffsetInclusiveIntegercompensación de finalización del intervalo de texto
sizeNumberel tamaño de fuente

Volver

Text: 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

setFontSize(size)

Establece el tamaño de la fuente.

Parámetros

NombreTipoDescripción
sizeNumberel tamaño de fuente

Volver

Text: 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

setForegroundColor(startOffset, endOffsetInclusive, color)

Establece el color de primer plano para el rango de caracteres especificado.

Parámetros

NombreTipoDescripción
startOffsetIntegerCompensación de inicio del rango de texto
endOffsetInclusiveIntegercompensación de finalización del intervalo de texto
colorStringEl color de primer plano, con formato en notación CSS (como '#ffffff')

Volver

Text: 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

setForegroundColor(color)

Establece el color del primer plano.

Parámetros

NombreTipoDescripción
colorStringEl color de primer plano, con formato en notación CSS (como '#ffffff')

Volver

Text: 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

setItalic(italic)

Establece la configuración de cursiva.

Parámetros

NombreTipoDescripción
italicBooleanla configuración de cursiva

Volver

Text: 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

setItalic(startOffset, endOffsetInclusive, italic)

Establece la configuración de cursiva para el rango de caracteres especificado.

Parámetros

NombreTipoDescripción
startOffsetIntegerCompensación de inicio del rango de texto
endOffsetInclusiveIntegercompensación de finalización del intervalo de texto
italicBooleanla configuración de cursiva

Volver

Text: 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

setLinkUrl(startOffset, endOffsetInclusive, url)

Establece la URL del vínculo para el rango de caracteres especificado.

Parámetros

NombreTipoDescripción
startOffsetIntegerCompensación de inicio del rango de texto
endOffsetInclusiveIntegercompensación de finalización del intervalo de texto
urlStringla URL del vínculo

Volver

Text: 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

setLinkUrl(url)

Establece la URL del vínculo.

Parámetros

NombreTipoDescripción
urlStringla URL del vínculo

Volver

Text: 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

setStrikethrough(strikethrough)

Establece la configuración de tachado.

Parámetros

NombreTipoDescripción
strikethroughBooleanla configuración de tachado

Volver

Text: 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

setStrikethrough(startOffset, endOffsetInclusive, strikethrough)

Establece la configuración de tachado para el rango de caracteres especificado.

Parámetros

NombreTipoDescripción
startOffsetIntegerCompensación de inicio del rango de texto
endOffsetInclusiveIntegercompensación de finalización del intervalo de texto
strikethroughBooleanla configuración de tachado

Volver

Text: 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 del texto.

Parámetros

NombreTipoDescripción
textStringel nuevo contenido de texto

Volver

Text: 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(startOffset, endOffsetInclusive, textAlignment)

Establece la alineación del texto para un rango de caracteres determinado. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT y DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the first character in the first paragraph be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);

Parámetros

NombreTipoDescripción
startOffsetIntegercompensación inicial del rango de caracteres
endOffsetInclusiveIntegerel desplazamiento final del rango de caracteres (inclusive)
textAlignmentTextAlignmentel tipo de alineación del texto que se aplicará

Volver

Text: 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

NombreTipoDescripción
textAlignmentTextAlignmentel tipo de alineación del texto que se aplicará

Volver

Text: 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

setUnderline(underline)

Establece la configuración de subrayado.

Parámetros

NombreTipoDescripción
underlineBooleanla configuración de subrayado

Volver

Text: 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

setUnderline(startOffset, endOffsetInclusive, underline)

Establece la configuración de subrayado para el rango de caracteres especificado.

Parámetros

NombreTipoDescripción
startOffsetIntegerCompensación de inicio del rango de texto
endOffsetInclusiveIntegercompensación de finalización del intervalo de texto
underlineBooleanla configuración de subrayado

Volver

Text: 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