Es un elemento que representa un salto de página. Un Page puede estar dentro de un List o Paragraph, a menos que el List o el Paragraph estén dentro de un Table, Header, Footer o Footnote. Un elemento Page no puede contener ningún otro elemento. Para obtener más información sobre la estructura de los documentos, consulta la guía para extender Documentos de Google.
Métodos
| Método | Tipo de datos que se muestra | Descripción breve |
|---|---|---|
copy() | Page | Devuelve una copia profunda y separada del elemento actual. |
get | Object | Recupera los atributos del elemento. |
get | Element|null | Recupera el siguiente elemento hermano del elemento. |
get | Container | Recupera el elemento principal del elemento. |
get | Element|null | Recupera el elemento hermano anterior del elemento. |
get | Element | Recupera el Element del elemento. |
is | Boolean | Determina si el elemento está al final de Document. |
remove | Page | Quita el elemento de su elemento superior. |
set | Page | Establece los atributos del elemento. |
Documentación detallada
copy()
Devuelve 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 principal.
Volver
Page: 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
get Attributes()
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 de la enumeración Document.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const 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
get Next Sibling()
Recupera el siguiente elemento hermano del elemento.
El siguiente elemento hermano tiene el mismo elemento principal y sigue al elemento actual.
Volver
Element|null: Es el siguiente elemento hermano.
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
get Parent()
Recupera el elemento principal del elemento.
El elemento principal contiene el elemento actual.
Volver
Container: 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
get Previous Sibling()
Recupera el elemento hermano anterior del elemento.
El elemento hermano anterior tiene el mismo elemento principal y precede al elemento actual.
Volver
Element|null: Es el elemento hermano 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
get Type()
Recupera el Element del elemento.
Usa get para determinar el tipo exacto de un elemento determinado.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const 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
Element: 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
is At Document End()
Determina si el elemento está al final de Document.
Volver
Boolean: Indica si el elemento se encuentra 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
remove From Parent()
Quita el elemento de su elemento superior.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Volver
Page: Es el elemento quitado.
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
set Attributes(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 de la enumeración Document y cada valor de propiedad sea el nuevo valor que se aplicará.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const 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. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
attributes | Object | Son los atributos del elemento. |
Volver
Page: 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