Class NamedRange

NamedRange

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

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

// Create a named range that includes every table in the active tab.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var 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