Class Document

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.
Document

Es un documento que contiene texto enriquecido y elementos, como tablas y listas.

Los documentos se pueden abrir o crear con DocumentApp.

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

Métodos

MétodoTipo de datos que se muestraDescripción breve
addBookmark(position)BookmarkAgrega un Bookmark al Position dado.
addEditor(emailAddress)DocumentAgrega el usuario determinado a la lista de editores de Document.
addEditor(user)DocumentAgrega el usuario determinado a la lista de editores de Document.
addEditors(emailAddresses)DocumentAgrega el arreglo de usuarios determinado a la lista de editores de Document.
addFooter()FooterSectionAgrega una sección de pie de página del documento, si no existe.
addHeader()HeaderSectionAgrega una sección de encabezado de documento, si no existe ninguna.
addNamedRange(name, range)NamedRangeAgrega un NamedRange nuevo, que es un Range que tiene un nombre y un ID para permitir la recuperación posterior.
addViewer(emailAddress)DocumentAgrega el usuario determinado a la lista de usuarios de Document.
addViewer(user)DocumentAgrega el usuario determinado a la lista de usuarios de Document.
addViewers(emailAddresses)DocumentAgrega el arreglo de usuarios determinado a la lista de usuarios de Document.
getAs(contentType)BlobRecupera el contenido Document actual como un BLOB del tipo especificado.
getBlob()BlobRecupera el contenido Document actual como un BLOB.
getBody()BodyRecupera el Body del documento activo.
getBookmark(id)BookmarkObtiene el Bookmark con el ID dado.
getBookmarks()Bookmark[]Obtiene todos los objetos Bookmark del documento.
getCursor()PositionObtiene el cursor del usuario en el documento activo.
getEditors()User[]Obtiene la lista de editores para este Document.
getFooter()FooterSectionRecupera la sección del pie de página del documento, si existe.
getFootnotes()Footnote[]Recupera todos los elementos Footnote del cuerpo del documento.
getHeader()HeaderSectionRecupera la sección de encabezado del documento, si existe.
getId()StringRecupera el identificador único del documento.
getLanguage()StringObtiene el código de idioma del documento.
getName()StringRecupera el título del documento.
getNamedRangeById(id)NamedRangeObtiene el NamedRange con el ID dado.
getNamedRanges()NamedRange[]Obtiene todos los objetos NamedRange del documento.
getNamedRanges(name)NamedRange[]Obtiene todos los objetos NamedRange del documento con el nombre determinado.
getSelection()RangeObtiene la selección del usuario en el documento activo.
getSupportedLanguageCodes()String[]Obtiene todos los códigos de idioma que se admiten en los archivos de Documentos de Google.
getUrl()StringRecupera la URL para acceder al documento actual.
getViewers()User[]Obtiene la lista de lectores y comentaristas de esta Document.
newPosition(element, offset)PositionCrea un Position nuevo, que es una referencia a una ubicación en el documento, en relación con un elemento específico.
newRange()RangeBuilderCrea un compilador que se usa para construir objetos Range a partir de elementos de documentos.
removeEditor(emailAddress)DocumentQuita al usuario específico de la lista de editores de Document.
removeEditor(user)DocumentQuita al usuario específico de la lista de editores de Document.
removeViewer(emailAddress)DocumentQuita al usuario específico de la lista de lectores y comentaristas del Document.
removeViewer(user)DocumentQuita al usuario específico de la lista de lectores y comentaristas del Document.
saveAndClose()voidGuarda el Document actual.
setCursor(position)DocumentEstablece el cursor del usuario en el documento activo en un Position.
setLanguage(languageCode)DocumentEstablece el código de idioma del documento.
setName(name)DocumentEstablece el título del documento.
setSelection(range)DocumentEstablece la selección del usuario en el documento activo en un Range.

Documentación detallada

addBookmark(position)

Agrega un Bookmark al Position dado.

Parámetros

NombreTipoDescripción
positionPositionla posición del nuevo marcador

Volver

Bookmark: el nuevo favorito

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

addEditor(emailAddress)

Agrega el usuario determinado a la lista de editores de Document. Si el usuario ya estaba en la lista de usuarios, este método promociona al usuario fuera de la lista de espectadores.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que se agregará.

Volver

Document: Este Document, para encadenar.

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

addEditor(user)

Agrega el usuario determinado a la lista de editores de Document. Si el usuario ya estaba en la lista de usuarios, este método promociona al usuario fuera de la lista de espectadores.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se agregará.

Volver

Document: Este Document, para encadenar.

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

addEditors(emailAddresses)

Agrega el arreglo de usuarios determinado a la lista de editores de Document. Si alguno de los usuarios ya estaba en la lista de usuarios, este método los promociona fuera de la lista de usuarios.

Parámetros

NombreTipoDescripción
emailAddressesString[]Un arreglo de direcciones de correo electrónico de los usuarios que se agregarán.

Volver

Document: Este Document, para encadenar.

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

addFooter()

Agrega una sección de pie de página del documento, si no existe.

Volver

FooterSection: El pie de página 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

addHeader()

Agrega una sección de encabezado de documento, si no existe ninguna.

Volver

HeaderSection: Es el encabezado 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

addNamedRange(name, range)

Agrega un NamedRange nuevo, que es un Range que tiene un nombre y un ID para permitir la recuperación posterior. Los nombres no son necesariamente únicos; varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, al igual que una clase en HTML. En cambio, los ID son únicos dentro del documento, como un ID en HTML. Una vez que se agrega un NamedRange a un documento, no se puede modificar, solo se puede quitar.

Se puede acceder a un NamedRange desde cualquier secuencia de comandos que acceda al documento. Para evitar conflictos no deseados entre las secuencias de comandos, considera usar una string única como prefijo a los nombres de los rangos.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Parámetros

NombreTipoDescripción
nameStringel nombre del rango, que no tiene que ser único; los nombres de los rangos deben tener al menos 1 carácter y no más de 256 caracteres
rangeRangeel rango de elementos para asociar con el nombre; el rango puede ser la selección activa, un resultado de la búsqueda o se puede construir de forma manual con newRange()

Volver

NamedRange: el nuevo NamedRange

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

addViewer(emailAddress)

Agrega el usuario determinado a la lista de usuarios de Document. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que se agregará.

Volver

Document: Este Document, para encadenar.

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

addViewer(user)

Agrega el usuario determinado a la lista de usuarios de Document. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se agregará.

Volver

Document: Este Document, para encadenar.

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

addViewers(emailAddresses)

Agrega el arreglo de usuarios determinado a la lista de usuarios de Document. Si alguno de los usuarios ya estaba en la lista de editores, este método no tiene efecto en ellos.

Parámetros

NombreTipoDescripción
emailAddressesString[]Un arreglo de direcciones de correo electrónico de los usuarios que se agregarán.

Volver

Document: Este Document, para encadenar.

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

getAs(contentType)

Recupera el contenido Document actual como un BLOB del tipo especificado.

Parámetros

NombreTipoDescripción
contentTypeStringEl tipo de MIME al que se convertirá; en la actualidad, solo se admite 'application/pdf'

Volver

Blob: Es el documento actual como un BLOB.


getBlob()

Recupera el contenido Document actual como un BLOB.

Volver

Blob: Es el documento actual como un BLOB.


getBody()

Recupera el Body del documento activo.

Los documentos pueden contener diferentes tipos de secciones (p.ej., HeaderSection, FooterSection). La sección activa para un documento es Body.

Los métodos de elementos de Document delegan al elemento Body activo.

Volver

Body: Es la sección del cuerpo del documento activo.

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

getBookmark(id)

Obtiene el Bookmark con el ID dado. Este método muestra null si no existe tal Bookmark.

Parámetros

NombreTipoDescripción
idStringel ID de Bookmark

Volver

Bookmark: Es el Bookmark con el ID determinado o null si no existe tal Bookmark.

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

getBookmarks()

Obtiene todos los objetos Bookmark del documento.

Volver

Bookmark[]: Es un arreglo de los objetos Bookmark 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

getCursor()

Obtiene el cursor del usuario en el documento activo. Una secuencia de comandos solo puede acceder al cursor del usuario que ejecuta la secuencia de comandos y solo si está vinculada al documento.

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Volver

Position: Es una representación del cursor del usuario o null si el usuario no tiene un cursor en el documento o si la secuencia de comandos no está vinculada al 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

getEditors()

Obtiene la lista de editores para este Document.

Volver

User[]: Es un arreglo de usuarios con permiso de edició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

getFooter()

Recupera la sección del pie de página del documento, si existe.

Volver

FooterSection: El pie de página 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

getFootnotes()

Recupera todos los elementos Footnote del cuerpo del documento.

Las llamadas a getFootnotes generan una iteración en los elementos del documento. En el caso de documentos grandes, evita las llamadas innecesarias a este método.

Volver

Footnote[]: el pie de página 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

getHeader()

Recupera la sección de encabezado del documento, si existe.

Volver

HeaderSection: Es el encabezado 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

getId()

Recupera el identificador único del documento. El ID de documento se usa con DocumentApp.openById() para abrir una instancia de documento específica.

Volver

String: el ID 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

getLanguage()

Obtiene el código de idioma del documento. Este es el idioma que se muestra en el Idioma del archivo del editor de documentos, que puede no ser el idioma real que contiene el documento.

Volver

String: Es el idioma del documento o null si no está definido.

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

getName()

Recupera el título del documento.

Volver

String: Es el título 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

getNamedRangeById(id)

Obtiene el NamedRange con el ID dado. Este método muestra null si no existe ese NamedRange. Los nombres no son necesariamente únicos; varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, al igual que una clase en HTML. En cambio, los ID son únicos dentro del documento, como un ID en HTML.

Parámetros

NombreTipoDescripción
idStringel ID del rango, que es único dentro del documento

Volver

NamedRange: Es el NamedRange con el ID determinado o null si no existe ese rango.

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

getNamedRanges()

Obtiene todos los objetos NamedRange del documento.

Se puede acceder a un NamedRange desde cualquier secuencia de comandos que acceda al documento. Para evitar conflictos no deseados entre las secuencias de comandos, considera usar una string única como prefijo a los nombres de los rangos.

Volver

NamedRange[]: Es un arreglo de los objetos NamedRange del documento, que puede incluir varios rangos con el mismo nombre.

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

getNamedRanges(name)

Obtiene todos los objetos NamedRange del documento con el nombre determinado. Los nombres no son necesariamente únicos; varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, al igual que una clase en HTML. En cambio, los ID son únicos dentro del documento, como un ID en HTML.

Se puede acceder a un NamedRange desde cualquier secuencia de comandos que acceda al documento. Para evitar conflictos no deseados entre las secuencias de comandos, considera usar una string única como prefijo a los nombres de los rangos.

Parámetros

NombreTipoDescripción
nameStringel nombre del rango, que no es necesariamente único

Volver

NamedRange[]: Es un array de los objetos NamedRange del documento con el nombre determinado.

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

getSelection()

Obtiene la selección del usuario en el documento activo. Una secuencia de comandos solo puede acceder a la selección del usuario que ejecuta la secuencia de comandos y solo si está vinculada al documento.

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var elements = selection.getRangeElements();
  DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

Volver

Range: Es una representación de la selección del usuario o null si el usuario no tiene ningún elemento seleccionado en el documento, si solo se selecciona el final de un párrafo, si solo se selecciona el final de un párrafo y una línea nueva, o si la secuencia de comandos no está vinculada al 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

getSupportedLanguageCodes()

Obtiene todos los códigos de idioma que se admiten en los archivos de Documentos de Google.

Volver

String[]: Es un arreglo de códigos de idioma.

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

getUrl()

Recupera la URL para acceder al documento actual.

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

Volver

String: Es la URL para acceder al documento 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

getViewers()

Obtiene la lista de lectores y comentaristas de esta Document.

Volver

User[]: Es un arreglo de usuarios con permiso para ver o comentar.

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

newPosition(element, offset)

Crea un Position nuevo, que es una referencia a una ubicación en el documento, en relación con un elemento específico. El cursor del usuario se representa como un Position, entre otros usos.

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parámetros

NombreTipoDescripción
elementElementel elemento que contendrá el nuevo Position; debe ser un elemento Text o un elemento de contenedor como Paragraph
offsetIntegerpara elementos Text, la cantidad de caracteres antes de Position; para otros elementos, la cantidad de elementos secundarios antes de Position dentro del mismo elemento contenedor

Volver

Position: el nuevo Position

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

newRange()

Crea un compilador que se usa para construir objetos Range a partir de elementos de documentos.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Volver

RangeBuilder: el nuevo compilador

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

removeEditor(emailAddress)

Quita al usuario específico de la lista de editores de Document. Este método no impide que los usuarios accedan a Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si Document se comparte con todo el dominio del usuario o si el Document está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de lectores.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que se quitará.

Volver

Document: Este Document, para encadenar.

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

removeEditor(user)

Quita al usuario específico de la lista de editores de Document. Este método no impide que los usuarios accedan a Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si Document se comparte con todo el dominio del usuario o si el Document está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de lectores.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se quitará.

Volver

Document: Este Document, para encadenar.

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

removeViewer(emailAddress)

Quita al usuario específico de la lista de lectores y comentaristas del Document. Este método no tiene efecto si el usuario es un editor, no un lector ni comentarista. Este método tampoco impide que los usuarios accedan a Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si Document se comparte con todo el dominio del usuario o si el Document está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de editores.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que se quitará.

Volver

Document: Este Document para el encadenamiento.

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

removeViewer(user)

Quita al usuario específico de la lista de lectores y comentaristas del Document. Este método no tiene efecto si el usuario es un editor, no un visualizador. Este método tampoco impide que los usuarios accedan a Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si Document se comparte con todo el dominio del usuario o si Document está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de editores.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se quitará.

Volver

Document: Este Document para el encadenamiento.

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

saveAndClose()

Guarda el Document actual. Hace que se borren y apliquen las actualizaciones pendientes.

El método saveAndClose() se invoca automáticamente al final de la ejecución de la secuencia de comandos para cada Document editable abierto.

No se puede editar un Document cerrado. Usa DocumentApp.openById() a fin de volver a abrir un documento determinado para editarlo.

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

setCursor(position)

Establece el cursor del usuario en el documento activo en un Position. Una secuencia de comandos solo puede acceder al cursor del usuario que ejecuta la secuencia de comandos y solo si está vinculada al documento.

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parámetros

NombreTipoDescripción
positionPositionla nueva ubicación del cursor

Volver

Document: este Document, para encadenar

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

setLanguage(languageCode)

Establece el código de idioma del documento. Este es el idioma que se muestra en el Idioma del archivo del editor de documentos, que puede no ser el idioma real que contiene el documento. Usa getSupportedLanguageCodes() para obtener todos los códigos de idioma válidos.

Parámetros

NombreTipoDescripción
languageCodeStringEl código de idioma.

Volver

Document: Este Document, para encadenar.

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

setName(name)

Establece el título del documento.

Parámetros

NombreTipoDescripción
nameStringel nuevo título del documento

Volver

Document: Es el documento 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

setSelection(range)

Establece la selección del usuario en el documento activo en un Range. Una secuencia de comandos solo puede acceder a la selección del usuario que ejecuta la secuencia de comandos y solo si está vinculada al documento.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Parámetros

NombreTipoDescripción
rangeRangela nueva gama de elementos para seleccionar

Volver

Document: este Document, para encadenar

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