Class NamedRange

NamedRange

Range yang memiliki nama dan ID untuk memungkinkan pengambilan nanti. Nama tidak selalu unik; beberapa rentang berbeda dalam tab yang sama dapat memiliki nama yang sama, seperti class dalam HTML. Sebaliknya, ID bersifat unik dalam tab, seperti ID di HTML. Setelah ditambahkan ke tab, NamedRange tidak dapat diubah, hanya dapat dihapus.

NamedRange dapat diakses oleh skrip apa pun yang mengakses tab. Untuk menghindari konflik yang tidak diinginkan antar-skrip, pertimbangkan untuk menambahkan awalan string unik pada nama rentang. 

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

Metode

MetodeJenis nilai yang ditampilkanDeskripsi singkat
getId()StringMendapatkan ID NamedRange ini.
getName()StringMendapatkan nama NamedRange ini.
getRange()RangeMendapatkan rentang elemen yang terkait dengan NamedRange ini.
remove()voidMenghapus NamedRange ini dari tab.

Dokumentasi mendetail

getId()

Mendapatkan ID NamedRange ini. ID ini unik dalam tab.

Pulang pergi

String — ID rentang, yang unik dalam tab.

getName()

Mendapatkan nama NamedRange ini. Nama tidak harus unik.

Pulang pergi

String — Nama rentang, yang tidak harus unik.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getRange()

Mendapatkan rentang elemen yang terkait dengan NamedRange ini.

Pulang pergi

Range — Rentang elemen yang terkait dengan nama dan ID.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

remove()

Menghapus NamedRange ini dari tab. Metode ini tidak menghapus konten rentang; hanya menghapus referensi. Memanggil metode ini pada NamedRange yang telah dihapus tidak akan berpengaruh.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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