Un elemento genérico. Los contenidos de Document
se representan como elementos. Por ejemplo, ListItem
, Paragraph
y Table
son elementos y heredan todos los métodos definidos por Element
, como getType()
.
Cómo implementar clases
Nombre | Descripción breve |
---|---|
Body | Un elemento que representa el cuerpo de un documento. |
ContainerElement | Un elemento genérico que puede contener otros elementos. |
Date | Un elemento que representa una fecha con formato |
Equation | Un elemento que representa una expresión matemática. |
EquationFunction | Un elemento que representa una función en un Equation matemático. |
EquationFunctionArgumentSeparator | Un elemento que representa un separador de funciones en un Equation matemático. |
EquationSymbol | Un elemento que representa un símbolo en un Equation matemático. |
FooterSection | Un elemento que representa una sección de pie de página. |
Footnote | Un elemento que representa una nota al pie. |
FootnoteSection | Un elemento que representa una sección de nota al pie. |
HeaderSection | Un elemento que representa una sección de encabezado. |
HorizontalRule | Un elemento que representa una regla horizontal. |
InlineDrawing | Un elemento que representa un dibujo incorporado. |
InlineImage | Un elemento que representa una imagen incorporada. |
ListItem | Un elemento que representa un elemento de la lista. |
PageBreak | Un elemento que representa un salto de página. |
Paragraph | Un elemento que representa un párrafo. |
Person | Un elemento que representa un vínculo a una persona. |
RichLink | Un elemento que representa un vínculo a un recurso de Google, como un archivo de Drive o un video de YouTube. |
Table | Un elemento que representa una tabla. |
TableCell | Un elemento que representa una celda de la tabla. |
TableOfContents | Un elemento que contiene un índice. |
TableRow | Un elemento que representa una fila de la tabla. |
Text | Un elemento que representa una región de texto enriquecido. |
UnsupportedElement | Un elemento que representa una región desconocida o que no puede verse afectada por una secuencia de comandos, como un número de página. |
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
asBody() | Body | Muestra el elemento actual como Body . |
asDate() | Date | Muestra el elemento actual como Date . |
asEquation() | Equation | Muestra el elemento actual como Equation . |
asEquationFunction() | EquationFunction | Muestra el elemento actual como EquationFunction . |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | Muestra el elemento actual como EquationFunctionArgumentSeparator . |
asEquationSymbol() | EquationSymbol | Muestra el elemento actual como EquationSymbol . |
asFooterSection() | FooterSection | Muestra el elemento actual como FooterSection . |
asFootnote() | Footnote | Muestra el elemento actual como Footnote . |
asFootnoteSection() | FootnoteSection | Muestra el elemento actual como FootnoteSection . |
asHeaderSection() | HeaderSection | Muestra el elemento actual como HeaderSection . |
asHorizontalRule() | HorizontalRule | Muestra el elemento actual como HorizontalRule . |
asInlineDrawing() | InlineDrawing | Muestra el elemento actual como InlineDrawing . |
asInlineImage() | InlineImage | Muestra el elemento actual como InlineImage . |
asListItem() | ListItem | Muestra el elemento actual como ListItem . |
asPageBreak() | PageBreak | Muestra el elemento actual como PageBreak . |
asParagraph() | Paragraph | Muestra el elemento actual como Paragraph . |
asPerson() | Person | Muestra el elemento actual como Person . |
asRichLink() | RichLink | Muestra el elemento actual como RichLink , por ejemplo, un vínculo a un archivo de Hojas de cálculo de Google. |
asTable() | Table | Muestra el elemento actual como Table . |
asTableCell() | TableCell | Muestra el elemento actual como TableCell . |
asTableOfContents() | TableOfContents | Muestra el elemento actual como TableOfContents . |
asTableRow() | TableRow | Muestra el elemento actual como TableRow . |
asText() | Text | Muestra el elemento actual como Text . |
copy() | Element | Muestra una copia independiente y profunda del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getNextSibling() | Element | Recupera el siguiente elemento del mismo nivel del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el ElementType del elemento. |
isAtDocumentEnd() | Boolean | Determina si el elemento está al final de Document . |
merge() | Element | Combina el elemento con el elemento anterior del mismo tipo. |
removeFromParent() | Element | Quita el elemento de su elemento superior. |
setAttributes(attributes) | Element | Establece los atributos del elemento. |
Documentación detallada
asBody()
Muestra el elemento actual como Body
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
Body
: 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
asDate()
Muestra el elemento actual como Date
.
Cuando sepas que un elemento es un Date
, usa este método para establecer su tipo como Date
. Esto permite que el autocompletado en el editor de Apps Script te muestre los métodos que puedes usar con un Date
.
Volver
Date
: Es el elemento actual con su tipo configurado como Date
.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asEquation()
Muestra el elemento actual como Equation
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
Equation
: 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
asEquationFunction()
Muestra el elemento actual como EquationFunction
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
EquationFunction
: 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
asEquationFunctionArgumentSeparator()
Muestra el elemento actual como EquationFunctionArgumentSeparator
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
EquationFunctionArgumentSeparator
: 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
asEquationSymbol()
Muestra el elemento actual como EquationSymbol
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
EquationSymbol
: 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
asFootnote()
Muestra el elemento actual como Footnote
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
Footnote
: 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
asFootnoteSection()
Muestra el elemento actual como FootnoteSection
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
FootnoteSection
: 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
asHeaderSection()
Muestra el elemento actual como HeaderSection
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
HeaderSection
: 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
asHorizontalRule()
Muestra el elemento actual como HorizontalRule
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
HorizontalRule
: 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
asInlineDrawing()
Muestra el elemento actual como InlineDrawing
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
InlineDrawing
: 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
asInlineImage()
Muestra el elemento actual como InlineImage
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
InlineImage
: 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
asListItem()
Muestra el elemento actual como ListItem
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
ListItem
: 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
asPageBreak()
Muestra el elemento actual como PageBreak
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
PageBreak
: 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
asParagraph()
Muestra el elemento actual como Paragraph
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
Paragraph
: 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
asPerson()
Muestra el elemento actual como Person
.
Cuando sepas que un elemento es un Person
, usa este método para establecer su tipo como persona.
Esto permite que el autocompletado en el editor de Apps Script te muestre los métodos que puedes usar con un elemento de persona.
Volver
Person
: Es el elemento actual con su tipo configurado como Person
.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asRichLink()
Muestra el elemento actual como RichLink
, por ejemplo, un vínculo a un archivo de Hojas de cálculo de Google.
Cuando sepas que un elemento es un RichLink
, usa este método para establecer su tipo como RichLink
. Esto permite que el autocompletado en el editor de Apps Script te muestre los métodos que puedes usar con un RichLink
.
Volver
RichLink
: Es el elemento actual con su tipo configurado como RichLink
.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asTable()
Muestra el elemento actual como Table
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
Table
: 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
asTableCell()
Muestra el elemento actual como TableCell
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
TableCell
: 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
asTableOfContents()
Muestra el elemento actual como TableOfContents
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
TableOfContents
: 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
asTableRow()
Muestra el elemento actual como TableRow
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
TableRow
: 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
asText()
Muestra el elemento actual como Text
.
Usa este método para ayudar a que se complete automáticamente cada vez que se sabe que un elemento determinado es de un tipo específico.
Volver
Text
: el elemento actual.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
copy()
Muestra una copia independiente y profunda del elemento actual.
También se copiarán todos los elementos secundarios que contenga. El nuevo elemento no tiene un elemento principal.
Volver
Element
: 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
getAttributes()
Recupera los atributos del elemento.
El resultado es un objeto que contiene una propiedad para cada atributo de elemento válido en el que cada nombre de propiedad corresponde a un elemento 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]); }
Volver
Object
: los atributos del elemento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Recupera el siguiente elemento del mismo nivel del elemento.
El siguiente elemento del mismo nivel tiene el mismo elemento principal y sigue el elemento actual.
Volver
Element
: el siguiente elemento del mismo nivel.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Recupera el elemento principal del elemento.
El elemento principal contiene el elemento actual.
Volver
ContainerElement
: 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
getPreviousSibling()
Recupera el elemento del mismo nivel anterior del elemento.
El elemento anterior tiene el mismo elemento principal y precede al elemento actual.
Volver
Element
: 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
getType()
Recupera el ElementType
del elemento.
Usa getType()
para determinar el tipo exacto de un elemento determinado.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Volver
ElementType
: 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
isAtDocumentEnd()
Determina si el elemento está al final de Document
.
Volver
Boolean
: Indica si el elemento se encuentra al final del documento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Combina el elemento con el elemento anterior del mismo tipo.
Solo se pueden combinar elementos del mismo ElementType
. Todos los elementos secundarios contenidos en el elemento actual se mueven al elemento del mismo nivel anterior.
El elemento actual se quita del documento.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Volver
Element
: el elemento combinado.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Quita el elemento de su elemento superior.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Volver
Element
: 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
setAttributes(attributes)
Establece los atributos del elemento.
El parámetro de atributos especificado debe ser un objeto en el que cada nombre de propiedad sea un elemento en la enumeración DocumentApp.Attribute
y cada valor de propiedad sea el valor nuevo que se aplicará.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
attributes | Object | Los atributos del elemento. |
Volver
Element
: 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