Class Paragraph

Párrafo

Un elemento que representa un párrafo. Un Paragraph puede contener elementos Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak y Text. Si deseas obtener más información sobre la estructura de los documentos, consulta la guía para ampliar Documentos de Google.

Paragraphs no puede contener caracteres de línea nueva. Los caracteres de salto de línea ("\n") se convierten en caracteres de salto de línea ("IAP").

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

// Append a document header paragraph.
var header = body.appendParagraph("A Document");
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
var section = body.appendParagraph("Section 1");
section.setHeading(DocumentApp.ParagraphHeading.HEADING2);

// Append a regular paragraph.
body.appendParagraph("This is a typical paragraph.");

Métodos

MétodoTipo de datos que se muestraDescripción breve
addPositionedImage(image)PositionedImageCrea e inserta un PositionedImage nuevo desde el BLOB de imagen especificado.
appendHorizontalRule()HorizontalRuleCrea y agrega un HorizontalRule nuevo.
appendInlineImage(image)InlineImageCrea y agrega un InlineImage nuevo a partir del BLOB de imagen especificado.
appendInlineImage(image)InlineImageAgrega el InlineImage especificado.
appendPageBreak()PageBreakCrea y agrega un PageBreak nuevo.
appendPageBreak(pageBreak)PageBreakAgrega el PageBreak especificado.
appendText(text)TextCrea y agrega un nuevo elemento Text con el contenido especificado.
appendText(text)TextAgrega el elemento Text especificado.
clear()ParagraphBorra el contenido del elemento.
copy()ParagraphMuestra una copia profunda separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual, para editar.
findElement(elementType)RangeElementBusca un contenido subordinado del tipo especificado en el elemento.
findElement(elementType, from)RangeElementBusca en el contenido del elemento un elemento subordinado del tipo especificado a partir del RangeElement especificado.
findText(searchPattern)RangeElementBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElementBusca el contenido del elemento para el patrón de texto especificado, a partir de un resultado de la búsqueda determinado.
getAlignment()HorizontalAlignmentRecupera el HorizontalAlignment.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getHeading()ParagraphHeadingRecupera el ParagraphHeading.
getIndentEnd()NumberRecupera la sangría final en puntos.
getIndentFirstLine()NumberRecupera la sangría de la primera línea, en puntos.
getIndentStart()NumberRecupera la sangría inicial.
getLineSpacing()NumberRecupera el interlineado en puntos.
getLinkUrl()StringRecupera la URL del vínculo.
getNextSibling()ElementRecupera el siguiente elemento secundario del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParent()ContainerElementRecupera el elemento principal del elemento.
getPositionedImage(id)PositionedImageObtiene un PositionedImage por el ID de la imagen.
getPositionedImages()PositionedImage[]Obtiene todos los objetos PositionedImage anclados al párrafo.
getPreviousSibling()ElementRecupera el elemento del mismo nivel anterior del elemento.
getSpacingAfter()NumberRecupera el espacio después del elemento, en puntos.
getSpacingBefore()NumberRecupera el espacio antes del elemento, en puntos.
getText()StringRecupera el contenido del elemento como una string de texto.
getTextAlignment()TextAlignmentObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserta un HorizontalRule en el índice especificado.
insertInlineImage(childIndex, image)InlineImageCrea e inserta un InlineImage nuevo desde el BLOB de la imagen especificado, en el índice especificado.
insertInlineImage(childIndex, image)InlineImageInserta el objeto InlineImage determinado en el índice especificado.
insertPageBreak(childIndex)PageBreakCrea e inserta un nuevo PageBreak en el índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInserta el objeto PageBreak determinado en el índice especificado.
insertText(childIndex, text)TextCrea e inserta un elemento de texto nuevo en el índice especificado.
insertText(childIndex, text)TextInserta el elemento Text determinado en el índice especificado, con el contenido de texto especificado.
isAtDocumentEnd()BooleanDetermina si el elemento se encuentra al final de Document.
isLeftToRight()BooleanRecupera la configuración de izquierda a derecha.
merge()ParagraphCombina el elemento con el elemento anterior del mismo tipo.
removeChild(child)ParagraphQuita el elemento secundario especificado.
removeFromParent()ParagraphQuita el elemento de su elemento superior.
removePositionedImage(id)BooleanQuita una PositionedImage del ID de la imagen.
replaceText(searchPattern, replacement)ElementReemplaza todas las apariciones de un patrón de texto dado por una string de reemplazo determinada mediante expresiones regulares.
setAlignment(alignment)ParagraphEstablece el HorizontalAlignment.
setAttributes(attributes)ParagraphEstablece los atributos del elemento.
setHeading(heading)ParagraphEstablece el ParagraphHeading.
setIndentEnd(indentEnd)ParagraphEstablece la sangría final, en puntos.
setIndentFirstLine(indentFirstLine)ParagraphEstablece la sangría de la primera línea, en puntos.
setIndentStart(indentStart)ParagraphEstablece la sangría de inicio, en puntos.
setLeftToRight(leftToRight)ParagraphEstablece la configuración de izquierda a derecha.
setLineSpacing(multiplier)ParagraphEstablece el interlineado, que es una cantidad que indica la cantidad de líneas que se usarán para el espaciado.
setLinkUrl(url)ParagraphEstablece la URL del vínculo.
setSpacingAfter(spacingAfter)ParagraphEstablece el espaciado después del elemento, en puntos.
setSpacingBefore(spacingBefore)ParagraphEstablece el espaciado antes del elemento, en puntos.
setText(text)voidEstablece el contenido del párrafo como texto.
setTextAlignment(textAlignment)ParagraphEstablece la alineación del texto.

Documentación detallada

addPositionedImage(image)

Crea e inserta un PositionedImage nuevo desde el BLOB de imagen especificado.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the specified image URL.
const image =
  UrlFetchApp.fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png');

// Adds the image to the document, anchored to the first paragraph.
paragraph.addPositionedImage(image);

Parámetros

NombreTipoDescripción
imageBlobSourceLos datos de la imagen.

Volver

PositionedImage: Es la nueva imagen posicionada.

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

appendHorizontalRule()

Crea y agrega un HorizontalRule nuevo.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a horizontal line under the first paragraph.
paragraph.appendHorizontalRule();

Volver

HorizontalRule: La regla horizontal 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

appendInlineImage(image)

Crea y agrega un InlineImage nuevo a partir del BLOB de imagen especificado.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the image from the specified image URL.
const image = UrlFetchApp
  .fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png');

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

Parámetros

NombreTipoDescripción
imageBlobSourceLos datos de la imagen.

Volver

InlineImage: Es la imagen adjunta.

Autorización

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

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

appendInlineImage(image)

Agrega el InlineImage especificado.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Makes a copy of the first image in the body.
const image = body.getImages()[0].copy();;

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

Parámetros

NombreTipoDescripción
imageInlineImageLos datos de la imagen.

Volver

InlineImage: Es la imagen adjunta.

Autorización

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

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

appendPageBreak()

Crea y agrega un PageBreak nuevo.

Nota: Es posible que PageBreaks no se encuentre dentro de TableCells. Si el elemento actual está contenido en una celda de la tabla, se arrojará una excepción.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
paragraph.appendPageBreak();

Volver

PageBreak: Es el nuevo elemento de salto de página.

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

appendPageBreak(pageBreak)

Agrega el PageBreak especificado.

Nota: PageBreaks no puede incluirse en TableCells. Si el elemento actual existe en una celda de la tabla, la secuencia de comandos arroja una excepción.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
const pageBreak = paragraph.appendPageBreak();

// Makes a copy of the page break.
const newPageBreak = pageBreak.copy();

// Adds the copied page break to the paragraph.
paragraph.appendPageBreak(newPageBreak);

Parámetros

NombreTipoDescripción
pageBreakPageBreakEl salto de página que se agregará.

Volver

PageBreak: Elemento de salto de página adjunto.

Autorización

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

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

appendText(text)

Crea y agrega un nuevo elemento Text con el contenido especificado.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a string to the paragraph.
paragraph.appendText('This is a new sentence.');

Parámetros

NombreTipoDescripción
textStringEl contenido del texto.

Volver

Text: Es el nuevo elemento 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

appendText(text)

Agrega el elemento Text especificado.

 // Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the text from the first paragraph in the body.
const paragraph1 = body.getParagraphs()[0];
const text = paragraph1.getText();

// Gets the third paragraph in the body.
const paragraph3 = body.getParagraphs()[2];

// Adds the text from the first paragraph to the third paragraph.
paragraph3.appendText(text);

Parámetros

NombreTipoDescripción
textTextEl elemento de texto que se agregará.

Volver

Text: Es el elemento de texto adjunto.

Autorización

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

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

clear()

Borra el contenido del elemento.

Volver

Paragraph: Es el elemento actual.


copy()

Muestra una copia profunda separada del elemento actual.

También se copian todos los elementos secundarios presentes. El elemento nuevo no tiene un elemento superior.

Volver

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

editAsText()

Obtiene una versión Text del elemento actual, para editar.

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

Los elementos secundarios que se encuentran completamente dentro de un rango de texto borrado se quitan del elemento.

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

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Volver

Text: Es una versión de texto del elemento actual.


findElement(elementType)

Busca un contenido subordinado del tipo especificado en el elemento.

Parámetros

NombreTipoDescripción
elementTypeElementTypeel tipo de elemento que se debe buscar

Volver

RangeElement: Es un resultado de la búsqueda que indica la posición 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

findElement(elementType, from)

Busca en el contenido del elemento un elemento subordinado del tipo especificado a partir del RangeElement especificado.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parámetros

NombreTipoDescripción
elementTypeElementTypeel tipo de elemento que se debe buscar
fromRangeElementel resultado de la búsqueda

Volver

RangeElement: Es un resultado de la búsqueda que indica la siguiente posición del elemento de búsqueda.

Autorización

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

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

findText(searchPattern)

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

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

El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto que se incluye en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringel patrón de búsqueda

Volver

RangeElement: Es un resultado de la búsqueda que indica la posición del texto de búsqueda o nulo si no hay 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 contenido del elemento para el patrón de texto especificado, a partir de un resultado de la búsqueda determinado.

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

El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto que se incluye en el elemento actual.

Parámetros

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

Volver

RangeElement: Es un resultado de la búsqueda que indica la siguiente posición del texto de búsqueda o nulo si no hay 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

getAlignment()

Recupera el HorizontalAlignment.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Sets the horizontal alignment to left for the first paragraph.
paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT);

// Gets the horizontal alignment of the first paragraph and logs it to the console.
console.log(paragraph.getAlignment().toString());

Volver

HorizontalAlignment: Es la alineación.

Autorización

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

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

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.

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

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

Volver

Object: los atributos del elemento.

Autorización

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

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

getChild(childIndex)

Recupera el elemento secundario en el índice secundario especificado.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

Parámetros

NombreTipoDescripción
childIndexIntegerel índice del elemento secundario que se recuperará

Volver

Element: Es el elemento secundario en el índice especificado.

Autorización

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

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

getChildIndex(child)

Recupera el índice secundario del elemento secundario especificado.

Parámetros

NombreTipoDescripción
childElementel elemento secundario para el que se recuperará el índice

Volver

Integer: Es el índice secundario.

Autorización

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

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

getHeading()

Recupera el ParagraphHeading.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Adds a paragraph to the body.
const paragraph = body.appendParagraph('Title heading');

// Sets the paragraph heading style to 'Title.'
paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE);

// Gets the heading style and logs it to the console.
console.log(paragraph.getHeading().toString());

Volver

ParagraphHeading: Es el encabezado.

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

getIndentEnd()

Recupera la sangría final en puntos.

Volver

Number: la sangría final, en puntos

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

getIndentFirstLine()

Recupera la sangría de la primera línea, en puntos.

Volver

Number: Sangría en la primera línea, en puntos

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

getIndentStart()

Recupera la sangría inicial.

Volver

Number: Es la sangría inicial.

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

getLineSpacing()

Recupera el interlineado en puntos.

Volver

Number: Interlineado, en puntos

Autorización

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

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

getLinkUrl()

Recupera la URL del vínculo.

Volver

String: Es la URL del vínculo, o bien un valor nulo si el elemento contiene varios valores para este atributo

Autorización

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

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

getNextSibling()

Recupera el siguiente elemento secundario del elemento.

El siguiente elemento del mismo nivel tiene el mismo elemento superior y sigue el 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

getNumChildren()

Recupera la cantidad de elementos secundarios.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

Volver

Integer: La cantidad de niños

Autorización

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

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

getParent()

Recupera el elemento principal del elemento.

El elemento principal 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

getPositionedImage(id)

Obtiene un PositionedImage por el ID de la imagen.

Parámetros

NombreTipoDescripción
idStringel ID de la imagen

Volver

PositionedImage: Es la imagen posicionada.

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

getPositionedImages()

Obtiene todos los objetos PositionedImage anclados al párrafo.

Volver

PositionedImage[]: Es una lista de imágenes de posicionamiento.

Autorización

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

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

getPreviousSibling()

Recupera el elemento del mismo nivel anterior del elemento.

El elemento secundario 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

getSpacingAfter()

Recupera el espacio después del elemento, en puntos.

Volver

Number: Espaciado después del elemento, en puntos

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

getSpacingBefore()

Recupera el espacio antes del elemento, en puntos.

Volver

Number: Espaciado previo al elemento, en puntos

Autorización

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

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

getText()

Recupera el contenido del elemento como una string de texto.

Volver

String: El contenido del elemento como string de texto

Autorización

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

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

getTextAlignment()

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

Volver

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

Autorización

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

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

getType()

Recupera el ElementType del elemento.

Usa getType() para determinar el tipo exacto de un elemento determinado.

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

// Obtain the first element in the document body.

var firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Volver

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

insertHorizontalRule(childIndex)

Crea e inserta un HorizontalRule en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se inserta el elemento

Volver

HorizontalRule: El nuevo elemento de la regla horizontal

Autorización

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

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

insertInlineImage(childIndex, image)

Crea e inserta un InlineImage nuevo desde el BLOB de la imagen especificado, en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se inserta el elemento
imageBlobSourcelos datos de la imagen

Volver

InlineImage: Es el elemento de imagen intercalado que se insertó.

Autorización

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

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

insertInlineImage(childIndex, image)

Inserta el objeto InlineImage determinado en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se inserta el elemento
imageInlineImagelos datos de la imagen

Volver

InlineImage: Es el elemento de imagen intercalado que se insertó.

Autorización

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

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

insertPageBreak(childIndex)

Crea e inserta un nuevo PageBreak en el índice especificado.

Nota: Es posible que PageBreaks no se encuentre dentro de TableCells. Si el elemento actual está contenido en una celda de la tabla, se arrojará una excepción.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se inserta el elemento

Volver

PageBreak: El nuevo elemento de salto de página

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

insertPageBreak(childIndex, pageBreak)

Inserta el objeto PageBreak determinado en el índice especificado.

Nota: Es posible que PageBreaks no se encuentre dentro de TableCells. Si el elemento actual está contenido en una celda de la tabla, se arrojará una excepción.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se inserta el elemento
pageBreakPageBreakel límite de edad que se debe insertar

Volver

PageBreak: Es el elemento de salto de página insertado.

Autorización

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

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

insertText(childIndex, text)

Crea e inserta un elemento de texto nuevo en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se inserta el elemento
textStringel contenido del texto

Volver

Text: Es el nuevo elemento 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

insertText(childIndex, text)

Inserta el elemento Text determinado en el índice especificado, con el contenido de texto especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se inserta el elemento
textTextel elemento de texto que se insertará

Volver

Text: Es el elemento de texto insertado.

Autorización

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

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

isAtDocumentEnd()

Determina si el elemento se encuentra al final de Document.

Volver

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

Autorización

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

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

isLeftToRight()

Recupera la configuración de izquierda a derecha.

Volver

Boolean: La configuración de izquierda a derecha

Autorización

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

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

merge()

Combina el elemento con el elemento anterior del mismo tipo.

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

El elemento actual se quita del documento.

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

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

Volver

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

removeChild(child)

Quita el elemento secundario especificado.

Parámetros

NombreTipoDescripción
childElementel elemento secundario que se quitará

Volver

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

removeFromParent()

Quita el elemento de su elemento superior.

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

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Volver

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

removePositionedImage(id)

Quita una PositionedImage del ID de la imagen.

Parámetros

NombreTipoDescripción
idStringel ID de la imagen

Volver

Boolean: Indica si se quitó o no la imagen especificada

Autorización

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

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

replaceText(searchPattern, replacement)

Reemplaza todas las apariciones de un patrón de texto dado por una string de reemplazo determinada mediante expresiones regulares.

El patrón de búsqueda se pasa como una string, no como un objeto de expresión regular de JavaScript. 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 compatible.

El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto que se incluye en el elemento actual.

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

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

Parámetros

NombreTipoDescripción
searchPatternStringel patrón de regex que se buscará
replacementStringel texto que se usará como reemplazo

Volver

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

setAlignment(alignment)

Establece el HorizontalAlignment.

Parámetros

NombreTipoDescripción
alignmentHorizontalAlignmentla alineación horizontal

Volver

Paragraph: 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 especificado debe ser un objeto en el que cada nombre de propiedad sea un elemento en la enumeración DocumentApp.Attribute y cada valor de propiedad sea el valor nuevo que se aplicará.

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

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parámetros

NombreTipoDescripción
attributesObjectLos atributos del elemento

Volver

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

setHeading(heading)

Establece el ParagraphHeading.

Parámetros

NombreTipoDescripción
headingParagraphHeadingel encabezado

Volver

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

setIndentEnd(indentEnd)

Establece la sangría final, en puntos.

Parámetros

NombreTipoDescripción
indentEndNumberla sangría final, en puntos

Volver

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

setIndentFirstLine(indentFirstLine)

Establece la sangría de la primera línea, en puntos.

Parámetros

NombreTipoDescripción
indentFirstLineNumbersangría de primera línea, en puntos

Volver

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

setIndentStart(indentStart)

Establece la sangría de inicio, en puntos.

Parámetros

NombreTipoDescripción
indentStartNumberla sangría inicial, en puntos

Volver

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

setLeftToRight(leftToRight)

Establece la configuración de izquierda a derecha.

Parámetros

NombreTipoDescripción
leftToRightBooleanel parámetro de izquierda a derecha

Volver

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

setLineSpacing(multiplier)

Establece el interlineado, que es una cantidad que indica la cantidad de líneas que se usarán para el espaciado.

Parámetros

NombreTipoDescripción
multiplierNumberla cantidad de líneas

Volver

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

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

setSpacingAfter(spacingAfter)

Establece el espaciado después del elemento, en puntos.

Parámetros

NombreTipoDescripción
spacingAfterNumberel espaciado posterior al elemento, en puntos

Volver

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

setSpacingBefore(spacingBefore)

Establece el espaciado antes del elemento, en puntos.

Parámetros

NombreTipoDescripción
spacingBeforeNumberel espaciado anterior al elemento, en puntos

Volver

Paragraph: 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 párrafo como texto.

Nota: Se borrará el contenido existente.

Parámetros

NombreTipoDescripción
textStringel nuevo contenido 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

setTextAlignment(textAlignment)

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

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

Parámetros

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

Volver

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