Class NamedRange

NamedRange

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 la misma pestaña pueden compartir el mismo nombre, al igual que una clase 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 quitar.

Se puede acceder a un NamedRange con cualquier secuencia de comandos que acceda a la pestaña. Para evitar conflictos no deseados entre las secuencias de comandos, considera agregar un prefijo a los nombres de rango con una cadena única. 

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

Métodos

MétodoTipo de datos que se devuelveDescripció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()voidQuita 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: Es 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: Es 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 permisos:

  • 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 permisos:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

remove()

Quita este NamedRange de la pestaña. Este método no borra el contenido del rango, solo quita la referencia. Llamar a este método en un NamedRange que ya se quitó 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 permisos:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents