Class Text

Texto

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 contenido en un Equation, EquationFunction. ListItem o Paragraph, pero no puede contener ningún otro elemento. Para ver más sobre la estructura de los documentos, consulta la guía para ampliar Documentos de Google.

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

// Use editAsText to obtain a single text element containing
// all the characters in the tab.
var 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 separada y profunda del elemento actual.
deleteText(startOffset, endOffsetInclusive)TextBorra un rango de texto.
editAsText()TextObtiene una versión Text del elemento actual para su edición.
findText(searchPattern)RangeElementBusca el patrón de texto especificado en el contenido del elemento mediante expresiones regulares.
findText(searchPattern, from)RangeElementBusca el patrón de texto especificado en el contenido del elemento, a partir de un valor determinado. resultado de la búsqueda.
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 con el desplazamiento de caracteres especificado.
getFontFamily()StringRecupera la configuración de la familia de fuentes.
getFontFamily(offset)StringRecupera la familia de fuentes con el desplazamiento de caracteres especificado.
getFontSize()NumberRecupera la configuración del tamaño de fuente.
getFontSize(offset)NumberRecupera el tamaño de fuente con el desplazamiento de caracteres especificado.
getForegroundColor()StringRecupera la configuración de color de primer plano.
getForegroundColor(offset)StringRecupera el color de primer plano con el desplazamiento de caracteres especificado.
getLinkUrl()StringRecupera la URL del vínculo.
getLinkUrl(offset)StringRecupera la URL del vínculo con el desplazamiento de caracteres especificado.
getNextSibling()ElementRecupera el elemento del mismo nivel del elemento.
getParent()ContainerElementRecupera el elemento superior del elemento.
getPreviousSibling()ElementRecupera el elemento del mismo nivel anterior.
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 de un solo carácter.
getTextAttributeIndices()Integer[]Recupera el conjunto de índices de texto que corresponden al inicio de un formato de texto distinto. o en cualquier plataforma que ejecute Knative.
getType()ElementTypeRecupera el ElementType del elemento.
insertText(offset, text)TextInserta el texto especificado en el desplazamiento de caracteres determinado.
isAtDocumentEnd()BooleanDetermina si el elemento se encuentra al final de Document.
isBold()BooleanRecupera la configuración en negrita.
isBold(offset)BooleanRecupera la configuración en negrita del 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 en el desplazamiento de caracteres especificado.
merge()TextCombina el elemento con el elemento del mismo nivel 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 dado por una cadena de reemplazo determinada, mediante la fórmula 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 la configuración en negrita.
setBold(startOffset, endOffsetInclusive, bold)TextDefine 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)TextDefine el tamaño de la fuente en 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 la configuración de cursiva.
setItalic(startOffset, endOffsetInclusive, italic)TextEstablece la configuración de cursiva en 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 en 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.

// 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(TAB_ID).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
textStringEl 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 alcances:

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

copy()

Muestra una copia separada y profunda del elemento actual.

También se copian los elementos secundarios presentes en el elemento. El elemento nuevo no tiene un 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 alcances:

  • 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(TAB_ID).asDocumentTab().getBody();

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

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: Es el elemento actual.

Autorización

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

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

editAsText()

Obtiene una versión Text del elemento actual para su edición.

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 estén completamente contenidos dentro de un rango de texto borrado se quitarán de este.

var 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 en texto del elemento actual.


findText(searchPattern)

Busca el patrón de texto especificado en el contenido del elemento mediante expresiones regulares.

Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como grupos de captura y modificadores de modo.

El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringel patrón a buscar

Volver

RangeElement: Es un resultado de la búsqueda que indica la posición del texto de búsqueda o nulo si no hay un valor. coincidencia

Autorización

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

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

findText(searchPattern, from)

Busca el patrón de texto especificado en el contenido del elemento, a partir de un valor determinado. resultado de la búsqueda.

Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como grupos de captura y modificadores de modo.

El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringel patrón a buscar
fromRangeElementel resultado de la búsqueda para buscar

Volver

RangeElement: Es un resultado de la búsqueda que indica la siguiente posición del texto de búsqueda o un valor nulo si no hay un valor. coincidencia

Autorización

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

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

getAttributes()

Recupera los atributos del elemento.

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

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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: Son los atributos del elemento.

Autorización

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

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

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 donde cada el nombre de la 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(TAB_ID).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 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: Es el color de fondo, con formato de notación CSS (como '#ffffff') 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 alcances:

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

getBackgroundColor(offset)

Recupera el color de fondo con 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(TAB_ID).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: Indica 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 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 de Documentos o Google Fonts, y distingue mayúsculas de minúsculas. Los métodos getFontFamily() y setFontFamily(fontFamilyName) ahora usan nombres de cadena para las fuentes en lugar de la enum FontFamily. Aunque esta enumeración es obsoleto, seguirá estando disponible para brindar compatibilidad con secuencias de comandos anteriores.

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 con el desplazamiento de caracteres especificado. El nombre puede ser cualquier fuente de la El menú Fuente en Documentos o Google Fonts, y es distingue mayúsculas de minúsculas. Los métodos getFontFamily() y setFontFamily(fontFamilyName) ahora usa nombres de cadena para las fuentes en lugar de la enum FontFamily. Aunque esta enumeración es obsoleto, seguirá estando 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(TAB_ID).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: Indica 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 del tamaño de fuente.

Volver

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

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

getFontSize(offset)

Recupera el tamaño de fuente con 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(TAB_ID).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 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 de primer plano.

Volver

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

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

getForegroundColor(offset)

Recupera el color de primer plano con 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(TAB_ID).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 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 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 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 con 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(TAB_ID).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 alcances:

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

getNextSibling()

Recupera el elemento del mismo nivel del elemento.

El elemento del mismo nivel tiene el mismo elemento superior y sigue al elemento actual.

Volver

Element: Es 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 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 alcances:

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

getPreviousSibling()

Recupera el elemento del mismo nivel anterior.

El elemento del mismo nivel anterior tiene el mismo elemento superior y precede al elemento actual.

Volver

Element: Es 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 cadena de texto.

Volver

String: Es el contenido del elemento como una cadena de texto.

Autorización

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

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

getTextAlignment()

Obtiene la alineación del texto. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT y DocumentApp.TextAlignment.SUPERSCRIPT.

Volver

TextAlignment: Es el tipo de alineación del texto, o null si el texto contiene varios tipos de texto. alineaciones o si nunca se estableció la alineación del texto

Autorización

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

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

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(TAB_ID).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
offsetIntegerEl desplazamiento del carácter.

Volver

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

Autorización

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

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

getTextAttributeIndices()

Recupera el conjunto de índices de texto que corresponden al inicio de un formato de texto distinto. o en cualquier plataforma que ejecute Knative.

// 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(TAB_ID).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 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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's 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: Es el tipo de elemento.

Autorización

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

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

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(TAB_ID).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
offsetIntegerEl desplazamiento de caracteres en el que se insertará el texto.
textStringTexto que se va a 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 alcances:

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

isAtDocumentEnd()

Determina si el elemento se encuentra 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 alcances:

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

isBold()

Recupera la configuración en negrita.

Volver

Boolean: Indica si el texto está en negrita o si es nulo si el elemento contiene varios valores para este elemento. 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 en negrita del 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(TAB_ID).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 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: Indica si el texto está en cursiva o si el elemento contiene varios valores, si es nulo. 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.

// 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(TAB_ID).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 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: Indica si el texto está tachado 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

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(TAB_ID).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 la 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 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 bien si el valor 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 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(TAB_ID).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 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 del mismo nivel anterior del mismo tipo.

Solo se pueden combinar elementos de la misma ElementType. Cualquier elemento secundario que se incluya en El elemento actual se mueve al elemento del mismo nivel anterior.

Se quitará el elemento actual del documento.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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: 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 alcances:

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

removeFromParent()

Quita el elemento de su elemento superior.

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

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var 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 alcances:

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

replaceText(searchPattern, replacement)

Reemplaza todos los casos de un patrón de texto dado por una cadena de reemplazo determinada, mediante la fórmula con expresiones regulares.

El patrón de búsqueda se pasa como una cadena, no como un objeto de expresión regular de JavaScript. Debido a esto, deberás escapar cualquier barra inversa en el patrón.

Este método usa el estándar RE2 de Google expresión de comandos, que limita la sintaxis compatible.

El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual.

var 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 para buscar
replacementStringel texto que se usará como reemplazo

Volver

Element: Es el elemento actual.

Autorización

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

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

setAttributes(startOffset, endOffsetInclusive, attributes)

Aplica los atributos especificados al rango de caracteres determinado.

El parámetro de atributos especificados debe ser un objeto en el que cada nombre de propiedad sea un elemento la enumeración DocumentApp.Attribute y el valor de cada propiedad es el nuevo que se debe se aplicó.

// 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(TAB_ID).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 alcances:

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

setAttributes(attributes)

Establece los atributos del elemento.

El parámetro de atributos especificados debe ser un objeto en el que cada nombre de propiedad sea un elemento la enumeración DocumentApp.Attribute y el valor de cada propiedad es el nuevo que se debe se aplicó.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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: Es el elemento actual.

Autorización

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

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

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(TAB_ID).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.
colorStringEs el 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 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 el 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 alcances:

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

setBold(bold)

Establece la configuración en negrita.

Parámetros

NombreTipoDescripción
boldBooleanla 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 alcances:

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

setBold(startOffset, endOffsetInclusive, bold)

Define la configuración de 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(TAB_ID).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.
boldBooleanLa 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 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 de la fuente en Documentos o Google Fonts y distingue mayúsculas de minúsculas. Los nombres de fuentes no reconocidos se procesarán como Arial. Los métodos getFontFamily(offset) y setFontFamily(fontFamilyName) ahora usa nombres de cadena para las fuentes en lugar de la enumeración FontFamily. Aunque esta enumeración es obsoleto, seguirá estando 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(TAB_ID).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.
fontFamilyNameStringEs el nombre de la familia de fuentes del menú Fuente de 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 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 de Documentos o Google Fonts, y distingue mayúsculas de minúsculas. Fuente no reconocida se renderizarán como Arial. Los métodos getFontFamily() y setFontFamily(fontFamilyName) ahora usan nombres de cadena para las fuentes en lugar de la enumeración FontFamily. Aunque esta enumeración es obsoleto, seguirá estando disponible para brindar compatibilidad con secuencias de comandos anteriores.

Parámetros

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

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

setFontSize(startOffset, endOffsetInclusive, size)

Define el tamaño de la fuente en 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(TAB_ID).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.
sizeNumberEs el tamaño de 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 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 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 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.

// 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(TAB_ID).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 alcances:

  • 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: Es el elemento actual.

Autorización

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

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

setItalic(italic)

Establece la configuración de cursiva.

Parámetros

NombreTipoDescripción
italicBooleanla configuración de 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 alcances:

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

setItalic(startOffset, endOffsetInclusive, italic)

Establece la configuración de cursiva en 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(TAB_ID).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.
italicBooleanLa configuración de 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 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.

// 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(TAB_ID).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.
urlStringEs la 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 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: Es el elemento actual.

Autorización

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

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

setStrikethrough(strikethrough)

Establece la configuración de tachado.

Parámetros

NombreTipoDescripción
strikethroughBooleanla 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 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.

// 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(TAB_ID).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.
strikethroughBooleanLa 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 alcances:

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

setText(text)

Establece el contenido del 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(TAB_ID).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 alcances:

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

setTextAlignment(startOffset, endOffsetInclusive, textAlignment)

Establece la alineación del texto en 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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);

Parámetros

NombreTipoDescripción
startOffsetIntegerEl desplazamiento inicial del rango de caracteres.
endOffsetInclusiveIntegerEs el desplazamiento final del rango de caracteres (inclusive).
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 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 in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var 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: Es el elemento actual.

Autorización

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

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

setUnderline(underline)

Establece la configuración de subrayado.

Parámetros

NombreTipoDescripción
underlineBooleanla 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 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.

// 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(TAB_ID).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.
underlineBooleanConfiguració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 alcances:

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