Elemento que representa un párrafo. Un Paragraph
puede contener Equation
, Footnote
, HorizontalRule
, InlineDrawing
, InlineImage
, PageBreak
,
y Text
. Si quieres 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 nueva línea ("\n") se muestran
se convierten en caracteres de salto de línea ("\r").
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a tab 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étodo | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addPositionedImage(image) | PositionedImage | Crea e inserta un PositionedImage nuevo desde el BLOB de imagen especificado. |
appendHorizontalRule() | HorizontalRule | Crea y agrega un HorizontalRule nuevo. |
appendInlineImage(image) | InlineImage | Crea y agrega un InlineImage nuevo desde el BLOB de imagen especificado. |
appendInlineImage(image) | InlineImage | Agrega el InlineImage especificado. |
appendPageBreak() | PageBreak | Crea y agrega un PageBreak nuevo. |
appendPageBreak(pageBreak) | PageBreak | Agrega el PageBreak especificado. |
appendText(text) | Text | Crea y agrega un nuevo elemento Text con el contenido especificado. |
appendText(text) | Text | Agrega el elemento Text especificado. |
clear() | Paragraph | Borra el contenido del elemento. |
copy() | Paragraph | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para su edición. |
findElement(elementType) | RangeElement | Busca en el contenido del elemento un elemento subordinado del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca en el contenido del elemento un elemento subordinado del tipo especificado, comenzando por el
especificado RangeElement . |
findText(searchPattern) | RangeElement | Busca el patrón de texto especificado en el contenido del elemento mediante expresiones regulares. |
findText(searchPattern, from) | RangeElement | Busca el patrón de texto especificado en el contenido del elemento, a partir de un valor determinado. resultado de la búsqueda. |
getAlignment() | HorizontalAlignment | Recupera el HorizontalAlignment . |
getAttributes() | Object | Recupera los atributos del elemento. |
getChild(childIndex) | Element | Recupera el elemento secundario del índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario del elemento secundario especificado. |
getHeading() | ParagraphHeading | Recupera el ParagraphHeading . |
getIndentEnd() | Number | Recupera la sangría final, en puntos. |
getIndentFirstLine() | Number | Recupera la sangría de la primera línea, en puntos. |
getIndentStart() | Number | Recupera la sangría de inicio. |
getLineSpacing() | Number | Recupera el interlineado, en puntos. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el elemento del mismo nivel del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getParent() | ContainerElement | Recupera el elemento superior del elemento. |
getPositionedImage(id) | PositionedImage | Obtiene un PositionedImage según el ID de la imagen. |
getPositionedImages() | PositionedImage[] | Obtiene todos los objetos PositionedImage anclados al párrafo. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior. |
getSpacingAfter() | Number | Recupera el espaciado después del elemento, en puntos. |
getSpacingBefore() | Number | Recupera el espaciado antes del elemento, en puntos. |
getText() | String | Recupera el contenido del elemento como una cadena de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el ElementType del elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea e inserta un HorizontalRule en el índice especificado. |
insertInlineImage(childIndex, image) | InlineImage | Crea e inserta un InlineImage nuevo del BLOB de imagen especificado, en el lugar especificado.
índice. |
insertInlineImage(childIndex, image) | InlineImage | Inserta el InlineImage proporcionado en el índice especificado. |
insertPageBreak(childIndex) | PageBreak | Crea e inserta un PageBreak nuevo en el índice especificado. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Inserta el PageBreak proporcionado en el índice especificado. |
insertText(childIndex, text) | Text | Crea e inserta un nuevo elemento de texto en el índice especificado. |
insertText(childIndex, text) | Text | Inserta el elemento Text determinado en el índice especificado, con el texto indicado.
contenidos. |
isAtDocumentEnd() | Boolean | Determina si el elemento se encuentra al final de Document . |
isLeftToRight() | Boolean | Recupera la configuración de izquierda a derecha. |
merge() | Paragraph | Combina el elemento con el elemento del mismo nivel anterior del mismo tipo. |
removeChild(child) | Paragraph | Quita el elemento secundario especificado. |
removeFromParent() | Paragraph | Quita el elemento de su elemento superior. |
removePositionedImage(id) | Boolean | Quita un PositionedImage según el ID de la imagen. |
replaceText(searchPattern, replacement) | Element | Reemplaza todos los casos de un patrón de texto dado por una cadena de reemplazo determinada, mediante la fórmula con expresiones regulares. |
setAlignment(alignment) | Paragraph | Establece el HorizontalAlignment . |
setAttributes(attributes) | Paragraph | Establece los atributos del elemento. |
setHeading(heading) | Paragraph | Establece el ParagraphHeading . |
setIndentEnd(indentEnd) | Paragraph | Establece la sangría final en puntos. |
setIndentFirstLine(indentFirstLine) | Paragraph | Establece la sangría de la primera línea en puntos. |
setIndentStart(indentStart) | Paragraph | Establece la sangría de inicio en puntos. |
setLeftToRight(leftToRight) | Paragraph | Establece la configuración de izquierda a derecha. |
setLineSpacing(multiplier) | Paragraph | Establece el interlineado como una cantidad que indica el número de líneas que se deben utilizar para el espaciado. |
setLinkUrl(url) | Paragraph | Establece la URL del vínculo. |
setSpacingAfter(spacingAfter) | Paragraph | Establece el espaciado después del elemento, en puntos. |
setSpacingBefore(spacingBefore) | Paragraph | Establece el espaciado antes del elemento, en puntos. |
setText(text) | void | Establece el contenido del párrafo como texto. |
setTextAlignment(textAlignment) | Paragraph | Establece 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // 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 | BlobSource | Los 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a horizontal line under the first paragraph. paragraph.appendHorizontalRule();
Volver
HorizontalRule
: 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
appendInlineImage(image)
Crea y agrega un InlineImage
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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // 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 | BlobSource | Los datos de la imagen |
Volver
InlineImage
: Es la imagen anexada.
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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // 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 | InlineImage | Los datos de la imagen |
Volver
InlineImage
: Es la imagen anexada.
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 en 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // 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 elemento nuevo 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: No se puede incluir PageBreaks
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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // 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 |
---|---|---|
pageBreak | PageBreak | El salto de página que se agregará. |
Volver
PageBreak
: 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
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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // 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 | El contenido del texto. |
Volver
Text
: Es el elemento 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
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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // 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 | El elemento de texto que se agregará. |
Volver
Text
: Es el elemento de texto 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
clear()
copy()
Muestra una copia profunda y separada del elemento actual.
También se copian los elementos secundarios presentes en el elemento. El elemento nuevo no tiene un 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 su edición.
Usa editAsText
para manipular el contenido de los elementos como texto enriquecido. El modo editAsText
ignora los elementos que no son de texto (como InlineImage
y HorizontalRule
).
Los elementos secundarios que estén completamente contenidos dentro de un rango de texto borrado se quitarán de este.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Volver
Text
: Es una versión en texto del elemento actual.
findElement(elementType)
Busca en el contenido del elemento un elemento subordinado del tipo especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
elementType | ElementType | El tipo de elemento que se buscará. |
Volver
RangeElement
: 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
findElement(elementType, from)
Busca en el contenido del elemento un elemento subordinado del tipo especificado, comenzando por el
especificado RangeElement
.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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
Nombre | Tipo | Descripción |
---|---|---|
elementType | ElementType | El tipo de elemento que se buscará. |
from | RangeElement | Es el 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 el patrón de texto especificado en el contenido del elemento mediante expresiones regulares.
Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como grupos de captura y modificadores de modo.
El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
searchPattern | String | el patrón a buscar |
Volver
RangeElement
: Es un resultado de la búsqueda que indica la posición del texto de búsqueda o nulo si no hay un valor.
coincidencia
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Busca el patrón de texto especificado en el contenido del elemento, a partir de un valor determinado. resultado de la búsqueda.
Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como grupos de captura y modificadores de modo.
El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
searchPattern | String | el patrón a buscar |
from | RangeElement | el resultado de la búsqueda para buscar |
Volver
RangeElement
: Es un resultado de la búsqueda que indica la siguiente posición del texto de búsqueda o un valor nulo si no hay un valor.
coincidencia
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // 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
el nombre de la propiedad corresponde a un elemento de la enumeración DocumentApp.Attribute
.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Volver
Object
: Son los atributos del elemento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Recupera el elemento secundario del índice secundario especificado.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. 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
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | El í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
Nombre | Tipo | Descripción |
---|---|---|
child | Element | El elemento secundario para el que se recupera 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // 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
: Es 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
: 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
getIndentStart()
Recupera la sangría de inicio.
Volver
Number
: 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
getLineSpacing()
Recupera el interlineado, en puntos.
Volver
Number
: 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
getLinkUrl()
Recupera la URL del vínculo.
Volver
String
: Es la URL del vínculo; o un valor nulo si el elemento contiene varios valores para este atributo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Recupera el elemento del mismo nivel del elemento.
El elemento del mismo nivel tiene el mismo elemento superior y sigue al elemento actual.
Volver
Element
: Es el siguiente elemento del mismo nivel.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Recupera la cantidad de elementos secundarios.
var 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 elementos secundarios.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Recupera el elemento superior del elemento.
El elemento superior contiene el elemento actual.
Volver
ContainerElement
: Es el elemento superior.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPositionedImage(id)
Obtiene un PositionedImage
según el ID de la imagen.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
id | String | el 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 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
getPreviousSibling()
Recupera el elemento del mismo nivel anterior.
El elemento del mismo nivel anterior tiene el mismo elemento superior y precede al elemento actual.
Volver
Element
: Es el elemento del mismo nivel anterior.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSpacingAfter()
Recupera el espaciado después del elemento, en puntos.
Volver
Number
: 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
getSpacingBefore()
Recupera el espaciado antes del elemento, en puntos.
Volver
Number
: Es el espaciado 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
getText()
Recupera el contenido del elemento como una cadena de texto.
Volver
String
: Es el contenido del elemento como una cadena de texto.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Obtiene la alineación del texto. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
y DocumentApp.TextAlignment.SUPERSCRIPT
.
Volver
TextAlignment
: Es el tipo de alineación del texto, o null
si el texto contiene varios tipos de texto.
alineaciones o si nunca se estableció la alineación del texto
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Recupera el ElementType
del elemento.
Usa getType()
para determinar el tipo exacto de un elemento determinado.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Volver
ElementType
: Es el tipo de elemento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
Crea e inserta un HorizontalRule
en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
Volver
HorizontalRule
: Es 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
insertInlineImage(childIndex, image)
Crea e inserta un InlineImage
nuevo del BLOB de imagen especificado, en el lugar especificado.
índice.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
image | BlobSource | los datos de la imagen |
Volver
InlineImage
: Es el elemento de imagen intercalada 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 InlineImage
proporcionado en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
image | InlineImage | los datos de la imagen |
Volver
InlineImage
: Es el elemento de imagen intercalada 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 PageBreak
nuevo en el índice especificado.
Nota: Es posible que PageBreaks
no se encuentre en TableCells
.
Si el elemento actual está contenido en una celda de la tabla, se arrojará una excepción.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
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
insertPageBreak(childIndex, pageBreak)
Inserta el PageBreak
proporcionado en el índice especificado.
Nota: Es posible que PageBreaks
no se encuentre en TableCells
.
Si el elemento actual está contenido en una celda de la tabla, se arrojará una excepción.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
pageBreak | PageBreak | la pausa de paginación para insertar |
Volver
PageBreak
: Es el elemento de salto de página 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
insertText(childIndex, text)
Crea e inserta un nuevo elemento de texto en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
text | String | 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
insertText(childIndex, text)
Inserta el elemento Text
determinado en el índice especificado, con el texto indicado.
contenidos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
text | Text | el elemento de texto para insertar |
Volver
Text
: Es el elemento de texto 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
isAtDocumentEnd()
Determina si el elemento se encuentra al final de Document
.
Volver
Boolean
: Indica si el elemento está al final de la pestaña.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isLeftToRight()
Recupera la configuración de izquierda a derecha.
Volver
Boolean
: Es 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 del mismo nivel anterior del mismo tipo.
Solo se pueden combinar elementos de la misma ElementType
. Cualquier elemento secundario que se incluya en
El elemento actual se mueve al elemento del mismo nivel anterior.
Se quitará el elemento actual del documento.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Volver
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
Nombre | Tipo | Descripción |
---|---|---|
child | Element | el elemento secundario para 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 doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab() var body = documentTab.getBody(); // Remove all images in the active tab's body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Volver
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 un PositionedImage
según el ID de la imagen.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
id | String | el 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 todos los casos de un patrón de texto dado por una cadena de reemplazo determinada, mediante la fórmula con expresiones regulares.
El patrón de búsqueda se pasa como una cadena, no como un objeto de expresión regular de JavaScript. Debido a esto, deberás escapar cualquier barra inversa en el patrón.
Este método usa el estándar RE2 de Google expresión de comandos, que limita la sintaxis compatible.
El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
searchPattern | String | el patrón de regex para 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
setAlignment(alignment)
Establece el HorizontalAlignment
.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
alignment | HorizontalAlignment | 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
setAttributes(attributes)
Establece los atributos del elemento.
El parámetro de atributos especificados debe ser un objeto en el que cada nombre de propiedad sea un elemento
la enumeración DocumentApp.Attribute
y el valor de cada propiedad es el nuevo que se debe
se aplicó.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
attributes | Object | 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
setHeading(heading)
Establece el ParagraphHeading
.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
heading | ParagraphHeading | 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
setIndentEnd(indentEnd)
Establece la sangría final en puntos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
indentEnd | 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
setIndentFirstLine(indentFirstLine)
Establece la sangría de la primera línea en puntos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
indentFirstLine | 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
setIndentStart(indentStart)
Establece la sangría de inicio en puntos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
indentStart | Number | la sangría de inicio, 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
Nombre | Tipo | Descripción |
---|---|---|
leftToRight | Boolean | la 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
setLineSpacing(multiplier)
Establece el interlineado como una cantidad que indica el número de líneas que se deben utilizar para el espaciado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
multiplier | Number | el número 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
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
setSpacingAfter(spacingAfter)
Establece el espaciado después del elemento, en puntos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
spacingAfter | 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
setSpacingBefore(spacingBefore)
Establece el espaciado antes del elemento, en puntos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
spacingBefore | 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
setText(text)
Establece el contenido del párrafo como texto.
Nota: Se borrará el contenido existente.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | el 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 in the active tab be superscript. var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); var text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
textAlignment | TextAlignment | 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