Un objeto Range
que tenga 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 IDs 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.
Cualquier secuencia de comandos que acceda al documento puede acceder a un NamedRange
. Para evitar conflictos accidentales entre secuencias de comandos, considera agregar un prefijo a los nombres de los rangos con una cadena única.
// Create a named 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.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getId() | String | Obtiene el ID de este NamedRange . |
getName() | String | Obtiene el nombre de este NamedRange . |
getRange() | Range | Obtiene el rango de elementos asociados con esta NamedRange . |
remove() | void | Quita este elemento NamedRange del documento. |
Documentación detallada
getId()
Obtiene el ID de este NamedRange
. El ID es único dentro del documento.
Devolvedor
String
: Es el ID del rango, que es único dentro del documento.
getName()
Obtiene el nombre de este NamedRange
. El nombre no es necesariamente único.
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getRange()
Obtiene el rango de elementos asociados con esta NamedRange
.
Devolvedor
Range
: 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()
Quita este elemento NamedRange
del documento. Este método no borra el contenido del rango; simplemente 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents