Class FootnoteSection

Agrega el Paragraph determinado.

Usa esta versión de appendParagraph cuando agregues una copia de un Paragraph existente.

Parámetros

Devolvedor

Paragraph: El párrafo adjunto

Autorización

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

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

Crea y agrega un Paragraph nuevo con el contenido de texto especificado.

Parámetros

Devolvedor

Paragraph: Es el nuevo párrafo.

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

Borra el contenido del elemento.

Devolvedor

FootnoteSection: Es el elemento actual.

Muestra 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 superior.

Devolvedor

FootnoteSection: Es la nueva copia.

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

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

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

Los elementos secundarios completamente contenidos en un rango de texto borrado se quitan del elemento.

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

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

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

Devolvedor

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

Busca en el contenido del elemento un elemento subordinado del tipo especificado.

Parámetros

Devolvedor

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

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

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

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

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

Parámetros

Devolvedor

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

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

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

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

Parámetros

Devolvedor

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

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

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

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

Parámetros

Devolvedor

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

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 en la enumeración DocumentApp.Attribute.

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

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

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

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

Devolvedor

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

Recupera el elemento secundario en el índice secundario especificado.

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

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

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

Parámetros

Devolvedor

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

Recupera el índice secundario para el elemento secundario especificado.

Parámetros

Devolvedor

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

Recupera el siguiente elemento del mismo nivel del elemento.

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

Devolvedor

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

Recupera la cantidad de elementos secundarios.

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

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

Devolvedor

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

Recupera todos los Paragraphs que se incluyen en la sección (incluido ListItems).

Devolvedor

Paragraph[]: Son los párrafos de la secció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

Recupera el elemento principal del elemento.

El elemento superior contiene el elemento actual.

Devolvedor

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

Recupera el elemento del mismo nivel anterior del elemento.

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

Devolvedor

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

Recupera el contenido del elemento como una string de texto.

Devolvedor

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

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

Devolvedor

TextAlignment: Es el tipo de alineación del texto, o null si el texto contiene varios tipos de alineaciones de texto 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

Recupera el ElementType del elemento.

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

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

// Obtain the first element in the document body.

var firstChild = body.getChild(0);

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

Devolvedor

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

Inserta el elemento Paragraph determinado en el índice especificado.

Parámetros

Devolvedor

Paragraph: Es el párrafo 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

Crea y, luego, inserta un Paragraph nuevo en el índice especificado, que contiene los contenidos de texto especificados.

Parámetros

Devolvedor

Paragraph: Es el nuevo párrafo.

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

Quita el elemento secundario especificado.

Parámetros

Devolvedor

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

Quita el elemento de su elemento superior.

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

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

Devolvedor

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

Reemplaza todos los casos de un patrón de texto determinado por una string de reemplazo determinada mediante expresiones regulares.

El patrón de búsqueda se pasa como una string y 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 la biblioteca de expresiones regulares RE2 de Google, que limita la sintaxis compatible.

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

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

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

Parámetros

Devolvedor

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

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

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

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

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

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

Parámetros

Devolvedor

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

Establece el contenido como texto sin formato.

Nota: Se borra el contenido existente.

Parámetros

Devolvedor

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

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

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

Parámetros

Devolvedor

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