Es 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 | Elemento que representa el cuerpo de un documento. |
ContainerElement | Elemento genérico que puede contener otros elementos. |
Date | Un elemento que representa una fecha con formato |
Equation | Elemento que representa una expresión matemática. |
EquationFunction | Elemento que representa una función en una Equation matemática. |
EquationFunctionArgumentSeparator | Un elemento que representa un separador de función en un Equation matemático. |
EquationSymbol | Elemento que representa un símbolo en una Equation matemática. |
FooterSection | Elemento que representa la sección de un pie de página. |
Footnote | Elemento que representa una nota al pie. |
FootnoteSection | Elemento que representa una sección de nota al pie. |
HeaderSection | Elemento que representa una sección de encabezado. |
HorizontalRule | Elemento que representa una regla horizontal. |
InlineDrawing | Elemento que representa un dibujo incorporado. |
InlineImage | Elemento que representa una imagen incorporada. |
ListItem | Elemento que representa un elemento de una lista. |
PageBreak | Elemento que representa un salto de página. |
Paragraph | Elemento que representa un párrafo. |
Person | Elemento que representa un vínculo a una persona. |
RichLink | Elemento que representa un vínculo a un recurso de Google, como un archivo de Drive o un video de YouTube. |
Table | Elemento que representa una tabla. |
TableCell | Elemento que representa una celda de una tabla. |
TableOfContents | Es un elemento que contiene un índice. |
TableRow | Elemento que representa una fila de tabla. |
Text | Elemento que representa una región de texto enriquecido. |
UnsupportedElement | Un elemento que representa una región que es 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 un Body . |
asDate() | Date | Muestra el elemento actual como un Date . |
asEquation() | Equation | Muestra el elemento actual como un Equation . |
asEquationFunction() | EquationFunction | Muestra el elemento actual como un EquationFunction . |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | Muestra el elemento actual como un EquationFunctionArgumentSeparator . |
asEquationSymbol() | EquationSymbol | Muestra el elemento actual como un EquationSymbol . |
asFooterSection() | FooterSection | Muestra el elemento actual como un FooterSection . |
asFootnote() | Footnote | Muestra el elemento actual como un Footnote . |
asFootnoteSection() | FootnoteSection | Muestra el elemento actual como un FootnoteSection . |
asHeaderSection() | HeaderSection | Muestra el elemento actual como un HeaderSection . |
asHorizontalRule() | HorizontalRule | Muestra el elemento actual como un HorizontalRule . |
asInlineDrawing() | InlineDrawing | Muestra el elemento actual como un InlineDrawing . |
asInlineImage() | InlineImage | Muestra el elemento actual como un InlineImage . |
asListItem() | ListItem | Muestra el elemento actual como un ListItem . |
asPageBreak() | PageBreak | Muestra el elemento actual como un PageBreak . |
asParagraph() | Paragraph | Muestra el elemento actual como un Paragraph . |
asPerson() | Person | Muestra el elemento actual como un Person . |
asRichLink() | RichLink | Muestra el elemento actual como un RichLink , por ejemplo, un vínculo a un archivo de Hojas de cálculo de Google. |
asTable() | Table | Muestra el elemento actual como un Table . |
asTableCell() | TableCell | Muestra el elemento actual como un TableCell . |
asTableOfContents() | TableOfContents | Muestra el elemento actual como un TableOfContents . |
asTableRow() | TableRow | Muestra el elemento actual como un TableRow . |
asText() | Text | Muestra el elemento actual como un Text . |
copy() | Element | Muestra una copia profunda y separada 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 se encuentra al final de Document . |
merge() | Element | Combina el elemento con el elemento del mismo nivel 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 un Body
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
Body
: 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
asDate()
Muestra el elemento actual como un Date
.
Cuando sepas que un elemento es un Date
, usa este método para establecer su tipo como Date
. De esta manera, permites que la función de autocompletado en el editor de Apps Script te muestre los métodos que puedes usar con un Date
.
Devolvedor
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 un Equation
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
Equation
: 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
asEquationFunction()
Muestra el elemento actual como un EquationFunction
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
EquationFunction
: 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
asEquationFunctionArgumentSeparator()
Muestra el elemento actual como un EquationFunctionArgumentSeparator
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
EquationFunctionArgumentSeparator
: 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
asEquationSymbol()
Muestra el elemento actual como un EquationSymbol
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
EquationSymbol
: 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
asFootnote()
Muestra el elemento actual como un Footnote
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
Footnote
: 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
asFootnoteSection()
Muestra el elemento actual como un FootnoteSection
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
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
asHeaderSection()
Muestra el elemento actual como un HeaderSection
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
HeaderSection
: 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
asHorizontalRule()
Muestra el elemento actual como un HorizontalRule
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
HorizontalRule
: 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
asInlineDrawing()
Muestra el elemento actual como un InlineDrawing
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
InlineDrawing
: 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
asInlineImage()
Muestra el elemento actual como un InlineImage
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
InlineImage
: 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
asListItem()
Muestra el elemento actual como un ListItem
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
ListItem
: 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
asPageBreak()
Muestra el elemento actual como un PageBreak
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
PageBreak
: 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
asParagraph()
Muestra el elemento actual como un Paragraph
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
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
asPerson()
Muestra el elemento actual como un Person
.
Cuando sepas que un elemento es un Person
, usa este método para establecer su tipo como una persona.
De esta manera, permites que la función de autocompletar en el editor de Apps Script te muestre los métodos que puedes usar con un elemento de persona.
Devolvedor
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 un 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
. De esta manera, permites que la función de autocompletado en el editor de Apps Script te muestre los métodos que puedes usar con un RichLink
.
Devolvedor
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 un Table
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
Table
: 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
asTableCell()
Muestra el elemento actual como un TableCell
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
TableCell
: 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
asTableOfContents()
Muestra el elemento actual como un TableOfContents
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
TableOfContents
: 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
asTableRow()
Muestra el elemento actual como un TableRow
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
TableRow
: 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
asText()
Muestra el elemento actual como un Text
.
Utiliza este método para facilitar la función de autocompletar cuando se sepa que un elemento determinado es de un tipo específico.
Devolvedor
Text
: 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
copy()
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
Element
: 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
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]); }
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
getNextSibling()
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
getParent()
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
getPreviousSibling()
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
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.'); }
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
isAtDocumentEnd()
Determina si el elemento se encuentra al final de Document
.
Devolvedor
Boolean
: Indica si el elemento está 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 del mismo nivel 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();
Devolvedor
Element
: 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
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(); }
Devolvedor
Element
: 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
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 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
Nombre | Tipo | Descripción |
---|---|---|
attributes | Object | Los atributos del elemento. |
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