Class Text

Texto

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

// Gets the body contents of the active tab.
const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

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

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

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

// Make the first half of the tab 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 profunda y separada del elemento actual.
deleteText(startOffset, endOffsetInclusive)TextBorra un rango de texto.
editAsText()TextObtiene una versión Text del elemento actual para editarlo.
findText(searchPattern)RangeElementBusca el patrón de texto especificado en el contenido del elemento con expresiones regulares.
findText(searchPattern, from)RangeElementBusca el patrón de texto especificado en el contenido del elemento, a partir de un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getAttributes(offset)ObjectRecupera los atributos en el desplazamiento de caracteres especificado.
getBackgroundColor()StringRecupera la configuración del 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 del tamaño de fuente.
getFontSize(offset)NumberRecupera el tamaño de fuente en el desplazamiento de caracteres especificado.
getForegroundColor()StringRecupera la configuración del color de 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 hermano del elemento.
getParent()ContainerElementRecupera el elemento superior del elemento.
getPreviousSibling()ElementRecupera el elemento hermano anterior del elemento.
getText()StringRecupera el contenido del elemento como una cadena 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 inicio de ejecuciones de formato de texto distintas.
getType()ElementTypeRecupera el ElementType del elemento.
insertText(offset, text)TextInserta el texto especificado en el desplazamiento de caracteres determinado.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
isBold()BooleanRecupera el parámetro de configuración en negrita.
isBold(offset)BooleanRecupera el parámetro de configuración en negrita en el desplazamiento de caracteres especificado.
isItalic()BooleanRecupera el parámetro de configuración en cursiva.
isItalic(offset)BooleanRecupera el parámetro de configuración en cursiva en el desplazamiento de caracteres especificado.
isStrikethrough()BooleanRecupera el parámetro de 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 en el desplazamiento de caracteres especificado.
merge()TextCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()TextQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada con 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 el formato en negrita.
setBold(startOffset, endOffsetInclusive, bold)TextEstablece el parámetro de configuración en negrita para el rango de caracteres especificado.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextEstablece la familia de fuentes para el rango de caracteres especificado.
setFontFamily(fontFamilyName)TextEstablece la familia de fuentes.
setFontSize(startOffset, endOffsetInclusive, size)TextEstablece el tamaño de fuente para el 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 de primer plano.
setItalic(italic)TextEstablece el formato itálico.
setItalic(startOffset, endOffsetInclusive, italic)TextEstablece el formato de itálicas 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 de 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 el parámetro de 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.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Adds the text, 'Sample body text,' to the end of the tab body.
const text = body.editAsText().appendText('Sample body text');

Parámetros

NombreTipoDescripción
textStringEs el texto que se agregará.

Volver

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

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

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

deleteText(startOffset, endOffsetInclusive)

Borra un rango de texto.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Deletes the first 10 characters in the body.
const text = body.editAsText().deleteText(0, 9);

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la compensación de caracteres del primer carácter que se borrará.
endOffsetInclusiveIntegerEs el desplazamiento de caracteres del último carácter que se borrará.

Volver

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

editAsText()

Obtiene una versión Text del elemento actual para editarlo.

Usa editAsText para manipular el contenido de los elementos como texto enriquecido. El modo editAsText ignora los elementos no textuales (como InlineImage y HorizontalRule).

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.


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

NombreTipoDescripción
searchPatternStringel patrón que se busca

Volver

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

NombreTipoDescripción
searchPatternStringel patrón que se busca
fromRangeElementel resultado de la búsqueda desde el que se realizará 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 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 DocumentApp.Attribute.

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

getAttributes(offset)

Recupera los atributos en el 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 de la enumeración DocumentApp.Attribute.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Declares style attributes.
const style = {};
style[DocumentApp.Attribute.BOLD] = true;
style[DocumentApp.Attribute.ITALIC] = true;
style[DocumentApp.Attribute.FONT_SIZE] = 29;

// Sets the style attributes to the tab's body.
const text = body.editAsText();
text.setAttributes(style);

// Gets the style attributes applied to the eleventh character in the
// body and logs them to the console.
const attributes = text.getAttributes(10);
console.log(attributes);

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento de caracteres.

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

getBackgroundColor()

Recupera la configuración del color de fondo.

Volver

String: Es el color de fondo, con formato de 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 ámbitos:

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the background color of the first 3 characters in the body.
const text = body.editAsText().setBackgroundColor(0, 2, '#FFC0CB');

// Gets the background color of the first character in the body.
const backgroundColor = text.getBackgroundColor(0);

// Logs the background color to the console.
console.log(backgroundColor);

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento de caracteres.

Volver

String: Es el color de fondo con formato de 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 ámbitos:

  • 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 Fuentes de Google, y distingue mayúsculas de minúsculas. Los métodos getFontFamily() y setFontFamily(fontFamilyName) ahora usan nombres de cadenas para las fuentes en lugar de la enumeración FontFamily. Aunque esta enumeración está obsoleta, seguirá disponible para brindar compatibilidad con secuencias de comandos anteriores.

Volver

String: Es la familia de fuentes 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

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 Fuentes de Google, y distingue mayúsculas de minúsculas. Los métodos getFontFamily() y setFontFamily(fontFamilyName) ahora usan nombres de cadenas para las fuentes en lugar de la enumeración FontFamily. Aunque esta enumeración está obsoleta, seguirá disponible para brindar compatibilidad con secuencias de comandos anteriores.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font of the first 16 characters to Impact.
const text = body.editAsText().setFontFamily(0, 15, 'Impact');

// Gets the font family of the 16th character in the tab body.
const fontFamily = text.getFontFamily(15);

// Logs the font family to the console.
console.log(fontFamily);

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento de caracteres.

Volver

String: Es 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 ámbitos:

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

getFontSize()

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

Volver

Number: Es el tamaño de la 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 ámbitos:

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

getFontSize(offset)

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font size of the first 13 characters to 15.
const text = body.editAsText().setFontSize(0, 12, 15);

// Gets the font size of the first character.
const fontSize = text.getFontSize(0);

// Logs the font size to the console.
console.log(fontSize);

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento de caracteres.

Volver

Number: Es 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 ámbitos:

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

getForegroundColor()

Recupera la configuración del color de primer plano.

Volver

String: Es el color de primer plano, con formato de 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 ámbitos:

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the foreground color of the first 3 characters in the tab body.
const text = body.editAsText().setForegroundColor(0, 2, '#0000FF');

// Gets the foreground color of the first character in the tab body.
const foregroundColor = text.getForegroundColor(0);

// Logs the foreground color to the console.
console.log(foregroundColor);

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento 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 ámbitos:

  • 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 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

getLinkUrl(offset)

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Applies a link to the first 10 characters in the body.
const text = body.editAsText().setLinkUrl(0, 9, 'https://www.example.com/');

// Gets the URL of the link from the first character.
const link = text.getLinkUrl(0);

// Logs the link URL to the console.
console.log(link);

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento 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 ámbitos:

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

getNextSibling()

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

getParent()

Recupera el elemento superior del elemento.

El elemento superior contiene el elemento actual.

Volver

ContainerElement: Es el elemento superior.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getPreviousSibling()

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

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the text alignment of the tab's body to NORMAL.
const text =
    body.editAsText().setTextAlignment(DocumentApp.TextAlignment.NORMAL);

// Gets the text alignment of the ninth character.
const alignment = text.getTextAlignment(8);

// Logs the text alignment to the console.
console.log(alignment.toString());

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento del carácter.

Volver

TextAlignment: Es el tipo de alineación de texto o null 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

getTextAttributeIndices()

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the text indices at which text formatting changes.
const indices = body.editAsText().getTextAttributeIndices();

// Logs the indices to the console.
console.log(indices.toString());

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 ámbitos:

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

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

ElementType: Es el tipo de elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

  • 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 determinado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Inserts the text, 'Sample inserted text', at the start of the body content.
const text = body.editAsText().insertText(0, 'Sample inserted text');

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento de caracteres en el que se inserta el texto.
textStringEs el texto que se insertará.

Volver

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

isAtDocumentEnd()

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

isBold()

Recupera el parámetro de configuración en negrita.

Volver

Boolean: Indica 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 ámbitos:

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

isBold(offset)

Recupera el parámetro de configuración en negrita en el desplazamiento de caracteres especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Bolds the first 4 characters in the tab body.
const text = body.editAsText().setBold(0, 3, true);

// Gets whether or not the text is bold.
const bold = text.editAsText().isBold(0);

// Logs the text's bold setting to the console
console.log(bold);

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento de caracteres.

Volver

Boolean: Es el parámetro de 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 ámbitos:

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

isItalic()

Recupera el parámetro de configuración en cursiva.

Volver

Boolean: Indica 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 ámbitos:

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

isItalic(offset)

Recupera el parámetro de configuración en cursiva en el desplazamiento de caracteres especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 13 characters of the tab body to italic.
const text = body.editAsText().setItalic(0, 12, true);

// Gets whether the fifth character in the tab body is set to
// italic and logs it to the console.
const italic = text.isItalic(4);
console.log(italic);

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento de caracteres.

Volver

Boolean: Es el parámetro de configuración en cursiva.

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

isStrikethrough()

Recupera el parámetro de configuración de tachado.

Volver

Boolean: Indica si el texto está tachado 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 ámbitos:

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 17 characters of the tab body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 16, true);

// Gets whether the first character in the tab body is set to
// strikethrough and logs it to the console.
const strikethrough = text.isStrikethrough(0);
console.log(strikethrough);

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento de caracteres.

Volver

Boolean: Es el parámetro de configuración de tachado.

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

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 ámbitos:

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

isUnderline(offset)

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 13 characters of the tab body to underline.
const text = body.editAsText().setUnderline(0, 12, false);

// Gets whether the first character in the tab body is set to
// underline and logs it to the console
const underline = text.editAsText().isUnderline(0);
console.log(underline);

Parámetros

NombreTipoDescripción
offsetIntegerEs el desplazamiento de caracteres.

Volver

Boolean: Es el parámetro de 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 ámbitos:

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

merge()

Combina el elemento con el hermano anterior del mismo tipo.

Solo se pueden combinar elementos del mismo ElementType. Todos los elementos secundarios que se encuentran en el elemento actual se mueven al elemento hermano anterior.

Se quita el elemento actual del documento.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Volver

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

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

NombreTipoDescripción
searchPatternStringel patrón de regex que se debe 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 ámbitos:

  • 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 de la enumeración DocumentApp.Attribute y cada valor de propiedad sea el valor nuevo que se aplicará.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Declares style attributes for font size and font family.
const style = {};
style[DocumentApp.Attribute.FONT_SIZE] = 20;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Impact';

// Sets the style attributes to the first 9 characters in the tab's body.
const text = body.setAttributes(0, 8, style);

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de texto.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de texto.
attributesObjectLos atributos del elemento

Volver

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

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 DocumentApp.Attribute 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

NombreTipoDescripción
attributesObjectLos atributos del elemento

Volver

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

setBackgroundColor(startOffset, endOffsetInclusive, color)

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the background color of the first 3 characters in the
// tab body to hex color #0000FF.
const text = body.editAsText().setBackgroundColor(0, 2, '#0000FF');

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de texto.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de texto.
colorStringEl color de fondo, con formato de notación CSS (como '#ffffff').

Volver

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

setBackgroundColor(color)

Establece el color de fondo.

Parámetros

NombreTipoDescripción
colorStringel color de fondo, con formato de 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 ámbitos:

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

setBold(bold)

Establece el formato en negrita.

Parámetros

NombreTipoDescripción
boldBooleanel parámetro de configuración en 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 ámbitos:

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

setBold(startOffset, endOffsetInclusive, bold)

Establece el parámetro de configuración en negrita para el rango de caracteres especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to bold.
const text = body.editAsText().setBold(0, 10, true);

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de texto.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de texto.
boldBooleanEl parámetro de configuración en negrita.

Volver

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

setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)

Establece la familia de fuentes para el rango de caracteres especificado. El nombre puede ser cualquier fuente del menú Fuente en Documentos o Fuentes de Google, y distingue mayúsculas de minúsculas. Los nombres de fuentes no reconocidos se renderizarán como Arial. Los métodos getFontFamily(offset) y setFontFamily(fontFamilyName) ahora usan nombres de cadenas para las fuentes en lugar de la enumeración FontFamily. Aunque esta enumeración está obsoleta, seguirá disponible para brindar compatibilidad con secuencias de comandos anteriores.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font of the first 4 characters in the tab's body to Roboto.
const text = body.editAsText().setFontFamily(0, 3, 'Roboto');

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de texto.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de texto.
fontFamilyNameStringEl nombre de la familia de fuentes, del menú Fuente en Documentos o Google Fonts

Volver

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

setFontFamily(fontFamilyName)

Establece la familia de fuentes. El nombre puede ser cualquier fuente del menú Fuente en Documentos o Fuentes de Google, y distingue mayúsculas de minúsculas. Los nombres de fuente que no se reconozcan se renderizarán como Arial. Los métodos getFontFamily() y setFontFamily(fontFamilyName) ahora usan nombres de cadenas para las fuentes en lugar de la enumeración FontFamily. Aunque esta enumeración está obsoleta, seguirá disponible para brindar compatibilidad con secuencias de comandos anteriores.

Parámetros

NombreTipoDescripción
fontFamilyNameStringel nombre de la familia de fuentes, en el menú Fuente de 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 ámbitos:

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

setFontSize(startOffset, endOffsetInclusive, size)

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the size of the first 11 characters in the tab's body to 12.
const text = body.editAsText().setFontSize(0, 10, 12);

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de texto.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de texto.
sizeNumberEl tamaño de la fuente.

Volver

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

setFontSize(size)

Establece el tamaño de la fuente.

Parámetros

NombreTipoDescripción
sizeNumberel tamaño de la 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 ámbitos:

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the foreground color of the first 2 characters in the
// tab's body to hex color #FF0000.
const text = body.editAsText().setForegroundColor(0, 1, '#FF0000');

// Gets the foreground color for the second character in the tab's body.
const foregroundColor = text.getForegroundColor(1);

//  Logs the foreground color to the console.
console.log(foregroundColor);

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de texto.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de texto.
colorStringEs el color de primer plano, con formato de notación CSS (como '#ffffff').

Volver

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

setForegroundColor(color)

Establece el color de primer plano.

Parámetros

NombreTipoDescripción
colorStringel color de primer plano, con formato de 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 ámbitos:

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

setItalic(italic)

Establece el formato itálico.

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 ámbitos:

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

setItalic(startOffset, endOffsetInclusive, italic)

Establece el formato de itálicas para el rango de caracteres especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to italic.
const text = body.editAsText().setItalic(0, 10, true);

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de texto.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de texto.
italicBooleanEl parámetro de configuración en cursiva

Volver

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

setLinkUrl(startOffset, endOffsetInclusive, url)

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Applies a link to the first 11 characters in the body.
const text = body.editAsText().setLinkUrl(0, 10, 'https://example.com');

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de texto.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de texto.
urlStringLa URL del vínculo.

Volver

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

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 ámbitos:

  • 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 ámbitos:

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 10, true);

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de texto.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de texto.
strikethroughBooleanEl parámetro de configuración de tachado.

Volver

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

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Replaces the contents of the body with the text, 'New body text.'
const text = body.editAsText().setText('New body text.');

Parámetros

NombreTipoDescripción
textStringEl nuevo contenido de texto

Volver

Text: 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(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 of the active tab be
// superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de caracteres.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de caracteres (inclusivo).
textAlignmentTextAlignmentEs el tipo de alineación de texto que se aplicará.

Volver

Text: 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 DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT y DocumentApp.TextAlignment.SUPERSCRIPT.

// 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

NombreTipoDescripción
textAlignmentTextAlignmentel tipo de alineación de 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 ámbitos:

  • 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
underlineBooleanel parámetro de 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 ámbitos:

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

setUnderline(startOffset, endOffsetInclusive, underline)

Establece el parámetro de configuración de subrayado para el rango de caracteres especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to underline.
const text = body.editAsText().setUnderline(0, 10, true);

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial del rango de texto.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de texto.
underlineBooleanEs la configuración de subrayado.

Volver

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