Un elemento genérico Los Document
contenidos son
representados como elementos. Por ejemplo, ListItem
, Paragraph
y Table
son
y heredan todos los métodos definidos por Element
, como getType()
.
Cómo implementar clases
Nombre | Descripción breve |
---|---|
Body | Es el contenido de una pestaña de un archivo de Documentos de Google. |
ContainerElement | Elemento genérico que puede contener otros elementos. |
Date | Elemento que representa una fecha con formato |
Equation | Elemento que representa una expresión matemática. |
EquationFunction | Elemento que representa una función en un Equation matemático. |
EquationFunctionArgumentSeparator | Elemento que representa un separador de función en un Equation matemático. |
EquationSymbol | Elemento que representa un símbolo en un Equation matemático. |
FooterSection | Elemento que representa una sección de 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 la 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 | Elemento que incluye un índice. |
TableRow | Elemento que representa una fila de la tabla. |
Text | 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 una el 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 una Body . |
asDate() | Date | Muestra el elemento actual como una Date . |
asEquation() | Equation | Muestra el elemento actual como un Equation . |
asEquationFunction() | EquationFunction | Muestra el elemento actual como una EquationFunction . |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | Muestra el elemento actual como una EquationFunctionArgumentSeparator . |
asEquationSymbol() | EquationSymbol | Muestra el elemento actual como una EquationSymbol . |
asFooterSection() | FooterSection | Muestra el elemento actual como una FooterSection . |
asFootnote() | Footnote | Muestra el elemento actual como una Footnote . |
asFootnoteSection() | FootnoteSection | Muestra el elemento actual como una FootnoteSection . |
asHeaderSection() | HeaderSection | Muestra el elemento actual como una HeaderSection . |
asHorizontalRule() | HorizontalRule | Muestra el elemento actual como una HorizontalRule . |
asInlineDrawing() | InlineDrawing | Muestra el elemento actual como una InlineDrawing . |
asInlineImage() | InlineImage | Muestra el elemento actual como una InlineImage . |
asListItem() | ListItem | Muestra el elemento actual como una ListItem . |
asPageBreak() | PageBreak | Muestra el elemento actual como una PageBreak . |
asParagraph() | Paragraph | Muestra el elemento actual como una Paragraph . |
asPerson() | Person | Muestra el elemento actual como una Person . |
asRichLink() | RichLink | Muestra el elemento actual como una RichLink , por ejemplo, un vínculo a un archivo de Hojas de cálculo de Google. |
asTable() | Table | Muestra el elemento actual como una Table . |
asTableCell() | TableCell | Muestra el elemento actual como una TableCell . |
asTableOfContents() | TableOfContents | Muestra el elemento actual como una TableOfContents . |
asTableRow() | TableRow | Muestra el elemento actual como una TableRow . |
asText() | Text | Muestra el elemento actual como una Text . |
copy() | Element | Muestra una copia profunda y separada del elemento actual. |
getAttributes() | Object | Recupera los atributos del elemento. |
getNextSibling() | Element | Recupera el elemento del mismo nivel del elemento. |
getParent() | ContainerElement | Recupera el elemento superior del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior. |
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 una Body
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una Date
.
Cuando sepas que un elemento es Date
, usa este método para establecer su tipo como Date
. Esto permite que la función de autocompletar 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 establecido 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
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una EquationFunction
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una EquationFunctionArgumentSeparator
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una EquationSymbol
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una Footnote
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una FootnoteSection
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una HeaderSection
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una HorizontalRule
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una InlineDrawing
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una InlineImage
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una ListItem
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una PageBreak
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una Paragraph
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
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
asPerson()
Muestra el elemento actual como una Person
.
Si sabes que un elemento es Person
, usa este método para establecer su tipo como persona.
Esto permite que la función de autocompletar en el editor de Apps Script te muestre los métodos que puedes usar con un
con un elemento humano.
Volver
Person
: Es el elemento actual con su tipo establecido 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 una RichLink
, por ejemplo, un vínculo a un archivo de Hojas de cálculo de Google.
Cuando sepas que un elemento es RichLink
, usa este método para establecer su tipo como RichLink
. Esto permite que el autocompletado del editor de Apps Script te muestre los métodos que puedes
usar con un RichLink
.
Volver
RichLink
: Es el elemento actual con su tipo establecido 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 una Table
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una TableCell
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una TableOfContents
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una TableRow
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 una Text
.
Usa este método para facilitar la función de autocompletar cuando se sepa que un determinado elemento pertenece a un elemento específico. el tipo de letra.
Volver
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 elemento nuevo no tiene un superior.
Volver
Element
: 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
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
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
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
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
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
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
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
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 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
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
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
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