Class NamedRange

Range ที่มีชื่อ

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