Class NamedRange

NamedRange

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

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

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

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
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