Class NamedRange

ช่วงที่มีชื่อ

Range ที่มีชื่อและ ID สําหรับอนุญาตให้ดึงข้อมูลในภายหลัง ชื่อไม่จําเป็นต้องซ้ํากัน ช่วงต่างๆ ในเอกสารเดียวกันอาจมีชื่อเดียวกัน เช่น ชั้นเรียนใน 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