Es un elemento que representa un párrafo. Un elemento Paragraph puede contener elementos Equation, Footnote, Horizontal, Inline, Inline, Page y Text. Para obtener más información sobre la estructura de los documentos, consulta la guía para extender Google Docs.
Paragraphs no puede contener caracteres de salto de línea. Los caracteres de salto de línea (“\n”) se convierten en caracteres de salto de línea (“\r”).
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a tab header paragraph. const header = body.appendParagraph('A Document'); header.setHeading(DocumentApp.ParagraphHeading.HEADING1); // Append a section header paragraph. const section = body.appendParagraph('Section 1'); section.setHeading(DocumentApp.ParagraphHeading.HEADING2); // Append a regular paragraph. body.appendParagraph('This is a typical paragraph.');
Métodos
| Método | Tipo de datos que se muestra | Descripción breve |
|---|---|---|
add | Positioned | Crea e inserta un nuevo Positioned a partir del blob de imagen especificado. |
append | Horizontal | Crea y agrega un nuevo Horizontal. |
append | Inline | Crea y agrega un nuevo Inline a partir del blob de imagen especificado. |
append | Inline | Agrega el Inline determinado. |
append | Page | Crea y agrega un nuevo Page. |
append | Page | Agrega el Page determinado. |
append | Text | Crea y agrega un nuevo elemento Text con el contenido especificado. |
append | Text | Anexa el elemento Text determinado. |
clear() | Paragraph | Borra el contenido del elemento. |
copy() | Paragraph | Devuelve una copia profunda y separada del elemento actual. |
edit | Text | Obtiene una versión Text del elemento actual para editarla. |
find | Range | Busca en el contenido del elemento un elemento secundario del tipo especificado. |
find | Range | Busca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el Range especificado. |
find | Range | Busca en el contenido del elemento el patrón de texto especificado con expresiones regulares. |
find | Range | Busca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado. |
get | Horizontal | Recupera el Horizontal. |
get | Object | Recupera los atributos del elemento. |
get | Element | Recupera el elemento secundario en el índice secundario especificado. |
get | Integer | Recupera el índice secundario del elemento secundario especificado. |
get | Paragraph | Recupera el Paragraph. |
get | Number|null | Recupera la sangría final, en puntos. |
get | Number|null | Recupera la sangría de la primera línea, en puntos. |
get | Number|null | Recupera la sangría inicial. |
get | Number|null | Recupera el interlineado, en puntos. |
get | String|null | Recupera la URL del vínculo. |
get | Element|null | Recupera el siguiente elemento hermano del elemento. |
get | Integer | Recupera la cantidad de elementos secundarios. |
get | Container | Recupera el elemento principal del elemento. |
get | Positioned | Obtiene un Positioned por el ID de la imagen. |
get | Positioned | Obtiene todos los objetos Positioned anclados al párrafo. |
get | Element|null | Recupera el elemento hermano anterior del elemento. |
get | Number|null | Recupera el espaciado después del elemento, en puntos. |
get | Number|null | Recupera el espaciado antes del elemento, en puntos. |
get | String | Recupera el contenido del elemento como una cadena de texto. |
get | Text | Obtiene la alineación del texto. |
get | Element | Recupera el Element del elemento. |
insert | Horizontal | Crea e inserta un Horizontal en el índice especificado. |
insert | Inline | Crea e inserta un nuevo Inline a partir del blob de imagen especificado en el índice especificado. |
insert | Inline | Inserta el Inline proporcionado en el índice especificado. |
insert | Page | Crea e inserta un nuevo Page en el índice especificado. |
insert | Page | Inserta el Page proporcionado en el índice especificado. |
insert | Text | Crea e inserta un nuevo elemento de texto en el índice especificado. |
insert | Text | Inserta el elemento Text determinado en el índice especificado, con el contenido de texto especificado. |
is | Boolean | Determina si el elemento está al final de Document. |
is | Boolean|null | Recupera el parámetro de configuración de izquierda a derecha. |
merge() | Paragraph|null | Combina el elemento con el hermano anterior del mismo tipo. |
remove | Paragraph | Quita el elemento secundario especificado. |
remove | Paragraph|null | Quita el elemento de su elemento superior. |
remove | Boolean | Quita un Positioned por el ID de la imagen. |
replace | Element | Reemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares. |
set | Paragraph | Establece el Horizontal. |
set | Paragraph | Establece los atributos del elemento. |
set | Paragraph | Establece el Paragraph. |
set | Paragraph | Establece la sangría final, en puntos. |
set | Paragraph | Establece la sangría de la primera línea, en puntos. |
set | Paragraph | Establece la sangría inicial, en puntos. |
set | Paragraph | Establece el parámetro de configuración de izquierda a derecha. |
set | Paragraph | Establece el interlineado como una cantidad que indica la cantidad de líneas que se usarán para el espaciado. |
set | Paragraph | Establece la URL del vínculo. |
set | Paragraph | Establece el espaciado después del elemento, en puntos. |
set | Paragraph | Establece el espaciado antes del elemento, en puntos. |
set | void | Establece el contenido del párrafo como texto. |
set | Paragraph | Establece la alineación del texto. |
Documentación detallada
add Positioned Image(image)
Crea e inserta un nuevo Positioned 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('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the 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 tab, anchored to the first paragraph. paragraph.addPositionedImage(image);
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
image | Blob | Son los datos de la imagen. |
Volver
Positioned: 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
append Horizontal Rule()
Crea y agrega un nuevo Horizontal.
// 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('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a horizontal line under the first paragraph. paragraph.appendHorizontalRule();
Volver
Horizontal: Es la nueva regla horizontal.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Inline Image(image)
Crea y agrega un nuevo Inline 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('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the 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
| Nombre | Tipo | Descripción |
|---|---|---|
image | Blob | Son los datos de la imagen. |
Volver
Inline: 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
append Inline Image(image)
Agrega el Inline determinado.
// 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('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the 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
| Nombre | Tipo | Descripción |
|---|---|---|
image | Inline | Son los datos de la imagen. |
Volver
Inline: 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
append Page Break()
Crea y agrega un nuevo Page.
Nota: Page no puede estar dentro de Table.
Si el elemento actual está contenido en una celda de 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('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a page break after the first paragraph. paragraph.appendPageBreak();
Volver
Page: 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
append Page Break(pageBreak)
Agrega el Page determinado.
Nota: Page no puede estar dentro de Table.
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('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the 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
| Nombre | Tipo | Descripción |
|---|---|---|
page | Page | Es el salto de página que se agregará. |
Volver
Page: Es el elemento de salto de página agregado.
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
append Text(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('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the 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
| Nombre | Tipo | Descripción |
|---|---|---|
text | String | Es el 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
append Text(text)
Anexa el elemento Text determinado.
// 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('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the text 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
| Nombre | Tipo | Descripción |
|---|---|---|
text | Text | Elemento de texto que se anexará. |
Volver
Text: Es el elemento de texto anexado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
clear()
copy()
Devuelve una copia profunda y separada del elemento actual.
También se copian los elementos secundarios presentes en el elemento. El nuevo elemento no tiene un elemento principal.
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
edit As Text()
Obtiene una versión Text del elemento actual para editarla.
Usa edit para manipular el contenido de los elementos como texto enriquecido. El modo edit ignora los elementos que no son de texto (como Inline y Horizontal).
Los elementos secundarios que se encuentran completamente dentro de un rango de texto borrado se quitan del elemento.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Volver
Text: Una versión de texto del elemento actual
find Element(elementType)
Busca en el contenido del elemento un elemento secundario del tipo especificado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
element | Element | Es el tipo de elemento que se buscará. |
Volver
Range: Es un resultado de la búsqueda que indica la posición del elemento de búsqueda.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Element(elementType, from)
Busca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el Range especificado.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
element | Element | Es el tipo de elemento que se buscará. |
from | Range | Es el resultado de la búsqueda desde el que se realizará la búsqueda. |
Volver
Range: 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
find Text(searchPattern)
Busca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
No se admite completamente un subconjunto de las funciones de expresiones regulares de JavaScript, 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 incluido en el elemento actual.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
search | String | El patrón que se debe buscar |
Volver
Range: Es un resultado de la búsqueda que indica la posición del texto de búsqueda o un valor nulo si no hay coincidencias.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
Busca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
No se admite completamente un subconjunto de las funciones de expresiones regulares de JavaScript, 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 incluido en el elemento actual.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
search | String | El patrón que se debe buscar |
from | Range | El resultado de la búsqueda desde el que se realizará la búsqueda |
Volver
Range: Un resultado de la búsqueda que indica la siguiente posición del texto de búsqueda o un valor nulo si no hay coincidencias
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Alignment()
Recupera el Horizontal.
// 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('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the 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
Horizontal: 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
get Attributes()
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 Document.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
Volver
Object: Son los atributos del elemento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Child(childIndex)
Recupera el elemento secundario en el índice secundario especificado.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
child | Integer | Í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
get Child Index(child)
Recupera el índice secundario del elemento secundario especificado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
child | Element | 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
get Heading()
Recupera el Paragraph.
// 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('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Adds 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
Paragraph: 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
get Indent End()
Recupera la sangría final, en puntos.
Volver
Number|null: 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
get Indent First Line()
Recupera la sangría de la primera línea, en puntos.
Volver
Number|null: Es la sangría de 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
get Indent Start()
Recupera la sangría inicial.
Volver
Number|null: Es la sangría de inicio.
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
get Line Spacing()
Recupera el interlineado, en puntos.
Volver
Number|null: Es el 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
get Link Url()
Recupera la URL del vínculo.
Volver
String|null: Es la URL del vínculo o nula 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
get Next Sibling()
Recupera el siguiente elemento hermano del elemento.
El siguiente elemento hermano tiene el mismo elemento principal y sigue al elemento actual.
Volver
Element|null: Es el siguiente elemento hermano.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Num Children()
Recupera la cantidad de elementos secundarios.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
Volver
Integer: Es la cantidad de hijos.
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
get Parent()
Recupera el elemento principal del elemento.
El elemento principal contiene el elemento actual.
Volver
Container: Es el elemento principal.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Positioned Image(id)
Obtiene un Positioned por el ID de la imagen.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | String | ID de la imagen |
Volver
Positioned: 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
get Positioned Images()
Obtiene todos los objetos Positioned anclados al párrafo.
Volver
Positioned: Una lista de imágenes posicionadas
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
get Previous Sibling()
Recupera el elemento hermano anterior del elemento.
El elemento hermano anterior tiene el mismo elemento principal y precede al elemento actual.
Volver
Element|null: Es el elemento hermano anterior.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Spacing After()
Recupera el espaciado después del elemento, en puntos.
Volver
Number|null: Es el 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
get Spacing Before()
Recupera el espaciado antes del elemento, en puntos.
Volver
Number|null: Es el espacio antes 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
get Text()
Recupera el contenido del elemento como una cadena de texto.
Volver
String: Contenido del elemento como cadena de texto
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Text Alignment()
Obtiene la alineación del texto. Los tipos de alineación disponibles son Document, Document y Document.
Volver
Text: Es el tipo de alineación del texto o null si el texto contiene varios tipos de alineación o 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
get Type()
Recupera el Element del elemento.
Usa get para determinar el tipo exacto de un elemento determinado.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Volver
Element: 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
insert Horizontal Rule(childIndex)
Crea e inserta un Horizontal en el índice especificado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
child | Integer | Índice en el que se insertará el elemento |
Volver
Horizontal: El nuevo elemento de 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
insert Inline Image(childIndex, image)
Crea e inserta un nuevo Inline a partir del blob de imagen especificado en el índice especificado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
child | Integer | Índice en el que se insertará el elemento |
image | Blob | los datos de la imagen |
Volver
Inline: El elemento de imagen intercalada 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
insert Inline Image(childIndex, image)
Inserta el Inline proporcionado en el índice especificado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
child | Integer | Índice en el que se insertará el elemento |
image | Inline | los datos de la imagen |
Volver
Inline: El elemento de imagen intercalada 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
insert Page Break(childIndex)
Crea e inserta un nuevo Page en el índice especificado.
Nota: Page no puede estar dentro de Table.
Si el elemento actual está contenido en una celda de tabla, se arrojará una excepción.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
child | Integer | Índice en el que se insertará el elemento |
Volver
Page: 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
insert Page Break(childIndex, pageBreak)
Inserta el Page proporcionado en el índice especificado.
Nota: Page no puede estar dentro de Table.
Si el elemento actual está contenido en una celda de tabla, se arrojará una excepción.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
child | Integer | Índice en el que se insertará el elemento |
page | Page | El salto de página que se insertará |
Volver
Page: 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
insert Text(childIndex, text)
Crea e inserta un nuevo elemento de texto en el índice especificado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
child | Integer | Índice en el que se insertará el elemento |
text | String | El contenido del texto |
Volver
Text: 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
insert Text(childIndex, text)
Inserta el elemento Text determinado en el índice especificado, con el contenido de texto especificado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
child | Integer | Índice en el que se insertará el elemento |
text | Text | Elemento de texto que se insertará |
Volver
Text: 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
is At Document End()
Determina si el elemento está al final de Document.
Volver
Boolean: Indica si el elemento se encuentra 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
is Left To Right()
Recupera el parámetro de configuración de izquierda a derecha.
Volver
Boolean|null: Es el parámetro de 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 hermano anterior del mismo tipo.
Solo se pueden combinar elementos del mismo Element. Todos los elementos secundarios incluidos en el elemento actual se mueven al elemento hermano anterior.
Se quita el elemento actual del documento.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
Volver
Paragraph|null: 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
remove Child(child)
Quita el elemento secundario especificado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
child | Element | 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
remove From Parent()
Quita el elemento de su elemento superior.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Volver
Paragraph|null: Es el elemento quitado.
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
remove Positioned Image(id)
Quita un Positioned por el ID de la imagen.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | String | 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
replace Text(searchPattern, replacement)
Reemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
El patrón de búsqueda se pasa como una cadena, no como un objeto de expresión regular de JavaScript. Por lo tanto, deberás escapar las barras inversas en el patrón.
Este método usa la biblioteca de expresiones regulares RE2 de Google, que limita la sintaxis admitida.
El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto incluido en el elemento actual.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
search | String | El patrón de regex que se debe buscar |
replacement | String | El 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
set Alignment(alignment)
Establece el Horizontal.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
alignment | Horizontal | la 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
set Attributes(attributes)
Establece los atributos del elemento.
El parámetro de atributos especificado debe ser un objeto en el que cada nombre de propiedad sea un elemento de la enumeración Document y cada valor de propiedad sea el nuevo valor que se aplicará.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
attributes | Object | Son los 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
set Heading(heading)
Establece el Paragraph.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
heading | Paragraph | el 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
set Indent End(indentEnd)
Establece la sangría final, en puntos.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
indent | Number | la 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
set Indent First Line(indentFirstLine)
Establece la sangría de la primera línea, en puntos.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
indent | Number | La sangría de la 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
set Indent Start(indentStart)
Establece la sangría inicial, en puntos.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
indent | Number | la 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
set Left To Right(leftToRight)
Establece el parámetro de configuración de izquierda a derecha.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
left | Boolean | el parámetro de configuración 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
set Line Spacing(multiplier)
Establece el interlineado como una cantidad que indica la cantidad de líneas que se usarán para el espaciado.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
multiplier | Number | La 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
set Link Url(url)
Establece la URL del vínculo.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
url | String | La 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
set Spacing After(spacingAfter)
Establece el espaciado después del elemento, en puntos.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
spacing | Number | El espaciado después del 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
set Spacing Before(spacingBefore)
Establece el espaciado antes del elemento, en puntos.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
spacing | Number | El espaciado antes del 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
set Text(text)
Establece el contenido del párrafo como texto.
Nota: Se borrará el contenido existente.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
text | String | El contenido de texto nuevo |
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
Establece la alineación del texto. Los tipos de alineación disponibles son Document, Document y Document.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
text | Text | El 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