Class NamedRange

NamedRange

Un objeto Range que tiene un ID y un nombre para permitir su posterior recuperación. Los nombres no son necesariamente únicos; varios intervalos diferentes en una misma pestaña pueden compartir el mismo nombre, al igual que un en HTML. Por el contrario, los IDs son únicos dentro de la pestaña, como un ID en HTML. Una vez que se agrega un NamedRange a una pestaña, no se puede modificar, solo se puede quitar.

Se puede acceder a un NamedRange con cualquier secuencia de comandos que acceda a la pestaña. Para evitar acciones conflictos entre secuencias de comandos, considera colocar un prefijo a los nombres de los rangos con una cadena única.

// Create a named range that includes every table in the active tab.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());

Métodos

MétodoTipo de datos que se muestraDescripción breve
getId()StringObtiene el ID de este NamedRange.
getName()StringObtiene el nombre de este NamedRange.
getRange()RangeObtiene el rango de elementos asociados con este NamedRange.
remove()voidElimina este NamedRange de la pestaña.

Documentación detallada

getId()

Obtiene el ID de este NamedRange. El ID es único dentro de la pestaña.

Volver

String: el ID del rango, que es único dentro de la pestaña.


getName()

Obtiene el nombre de este NamedRange. El nombre no es necesariamente único.

Volver

String: Indica el nombre del rango, que no es necesariamente único.

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

getRange()

Obtiene el rango de elementos asociados con este NamedRange.

Volver

Range: Es el rango de elementos asociados con el nombre y el ID.

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()

Elimina este NamedRange de la pestaña. Este método no borra el contenido del rango; solo la quita. Llamar a este método en un NamedRange que se quitó, pero no tiene ningún efecto.

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