Class NamedRange

NamedRange

Range ที่มีชื่อและรหัสเพื่อให้เรียกข้อมูลได้ในภายหลัง ชื่อไม่จำเป็นต้องไม่ซ้ำกัน ช่วงต่างๆ ในแท็บเดียวกันอาจใช้ชื่อเดียวกันได้ เช่นเดียวกับ คลาสใน HTML ในทางตรงกันข้าม รหัสจะไม่ซ้ำกันภายในแท็บ เช่น รหัสใน HTML เมื่อเพิ่ม NamedRange ลงในแท็บแล้ว คุณจะแก้ไขไม่ได้ ทำได้เพียงนำออกเท่านั้น

สคริปต์ใดก็ตามที่เข้าถึงแท็บจะเข้าถึง NamedRange ได้ ลองนำหน้าชื่อช่วงด้วยสตริงที่ไม่ซ้ำกันเพื่อหลีกเลี่ยงการขัดแย้งระหว่างสคริปต์โดยไม่ตั้งใจ

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

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
getId()Stringรับรหัสของ NamedRange นี้
getName()Stringรับชื่อของ NamedRange นี้
getRange()Rangeรับช่วงขององค์ประกอบที่เชื่อมโยงกับ NamedRange นี้
remove()voidนำ NamedRange นี้ออกจากแท็บ

เอกสารโดยละเอียด

getId()

รับรหัสของ NamedRange นี้ รหัสจะไม่ซ้ำกันภายในแท็บ

รีเทิร์น

String — รหัสของช่วงซึ่งไม่ซ้ำกันภายในแท็บ


getName()

รับชื่อของ NamedRange นี้ ชื่อไม่จำเป็นต้องไม่ซ้ำกัน

รีเทิร์น

String - ชื่อของช่วง ซึ่งอาจซ้ำกันได้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRange()

รับช่วงขององค์ประกอบที่เชื่อมโยงกับ NamedRange นี้

รีเทิร์น

Range — ช่วงขององค์ประกอบที่เชื่อมโยงกับชื่อและรหัส

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

remove()

นำ NamedRange นี้ออกจากแท็บ วิธีนี้จะไม่ลบเนื้อหาของ ช่วง แต่จะลบการอ้างอิงเท่านั้น การเรียกใช้เมธอดนี้ใน NamedRange ที่ถูกนำออกไปแล้วจะไม่มีผล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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