Class RangeBuilder

RangeBuilder

เครื่องมือสร้างที่ใช้เพื่อสร้างออบเจ็กต์ Range จากองค์ประกอบของเอกสาร

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
addElement(element)	RangeBuilder	เพิ่มทั้ง Element ลงใน RangeBuilder นี้
addElement(textElement, startOffset, endOffsetInclusive)	RangeBuilder	เพิ่มองค์ประกอบ Text บางส่วนลงใน RangeBuilder นี้
addElementsBetween(startElement, endElementInclusive)	RangeBuilder	เพิ่มองค์ประกอบทั้ง 2 รายการและองค์ประกอบทั้งหมดระหว่างองค์ประกอบทั้ง 2 รายการนี้ลงใน RangeBuilder
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)	RangeBuilder	เพิ่มองค์ประกอบ Text บางส่วน 2 รายการ และองค์ประกอบทั้งหมดระหว่างองค์ประกอบทั้ง 2 รายการลงใน RangeBuilder
addRange(range)	RangeBuilder	เพิ่มเนื้อหาของ Range อื่นลงใน RangeBuilder นี้
build()	Range	สร้าง Range จากการตั้งค่าที่ใช้กับเครื่องมือสร้าง
getRangeElements()	RangeElement[]	รับองค์ประกอบทั้งหมดใน Range นี้ รวมถึงองค์ประกอบ Text บางส่วน (เช่น ในกรณีที่เลือกเฉพาะส่วนหนึ่งขององค์ประกอบ Text)

วิธีการที่เลิกใช้งานแล้ว

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
getSelectedElements()	RangeElement[]	รับองค์ประกอบทั้งหมดที่ผู้ใช้เลือกในอินสแตนซ์ที่เปิดของเอกสาร ซึ่งรวมถึง องค์ประกอบที่เลือกบางส่วนText

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

addElement(element)

เพิ่ม Element ทั้งหมดลงใน RangeBuilder นี้

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
element	Element	องค์ประกอบที่จะเพิ่ม

รีเทิร์น

RangeBuilder - เครื่องมือสร้างนี้สำหรับการเชื่อมโยง

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

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

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

---

addElement(textElement, startOffset, endOffsetInclusive)

เพิ่มองค์ประกอบ Text บางส่วนลงใน RangeBuilder นี้

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
textElement	Text	องค์ประกอบของข้อความที่จะเพิ่มบางส่วน
startOffset	Integer	จำนวนอักขระก่อนอักขระแรกที่จะรวม (นั่นคือ ดัชนีของอักขระแรกในช่วง)
endOffsetInclusive	Integer	จำนวนอักขระก่อนอักขระสุดท้ายที่จะรวม (นั่นคือดัชนีของอักขระสุดท้ายในช่วง)

รีเทิร์น

RangeBuilder - เครื่องมือสร้างนี้สำหรับการเชื่อมโยง

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

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

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

---

addElementsBetween(startElement, endElementInclusive)

เพิ่มองค์ประกอบทั้ง 2 รายการและองค์ประกอบทั้งหมดระหว่างองค์ประกอบทั้ง 2 รายการนี้ลงใน RangeBuilder

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
startElement	Element	องค์ประกอบแรกที่จะเพิ่ม
endElementInclusive	Element	องค์ประกอบสุดท้ายที่จะเพิ่ม

รีเทิร์น

RangeBuilder - เครื่องมือสร้างนี้สำหรับการเชื่อมโยง

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

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

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

---

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

เพิ่มองค์ประกอบ Text บางส่วน 2 รายการ และองค์ประกอบทั้งหมดระหว่างองค์ประกอบทั้ง 2 รายการลงใน RangeBuilder

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
startTextElement	Text	องค์ประกอบของข้อความแรกที่จะเพิ่มบางส่วน
startOffset	Integer	จำนวนอักขระก่อนอักขระแรกของ startTextElement ที่จะรวม (นั่นคือ ดัชนีของอักขระแรกในช่วง)
endTextElementInclusive	Text	องค์ประกอบของข้อความสุดท้ายที่จะเพิ่มบางส่วน
endOffsetInclusive	Integer	จำนวนอักขระก่อนอักขระสุดท้ายของ endTextElementInclusive ที่จะรวม (นั่นคือ ดัชนีของอักขระสุดท้ายใน ช่วง)

รีเทิร์น

RangeBuilder - เครื่องมือสร้างนี้สำหรับการเชื่อมโยง

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

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

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

---

addRange(range)

เพิ่มเนื้อหาของ Range อื่นลงใน RangeBuilder นี้

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
range	Range	ช่วงที่ควรเพิ่มองค์ประกอบ

รีเทิร์น

RangeBuilder - เครื่องมือสร้างนี้สำหรับการเชื่อมโยง

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

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

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

---

build()

สร้าง Range จากการตั้งค่าที่ใช้กับเครื่องมือสร้าง

รีเทิร์น

Range — ช่วงที่สร้างขึ้นใหม่

---

getRangeElements()

รับองค์ประกอบทั้งหมดใน Range นี้ รวมถึงองค์ประกอบ Text บางส่วน (เช่น ในกรณีที่เลือกเฉพาะส่วนหนึ่งขององค์ประกอบ Text) หากต้องการดูว่าองค์ประกอบ Text มีอยู่ในช่วงเพียงบางส่วนหรือไม่ ให้ดู RangeElement.isPartial()

รีเทิร์น

RangeElement[] — อาร์เรย์ขององค์ประกอบตามลำดับที่ปรากฏในเอกสาร

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

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

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

วิธีการที่เลิกใช้งานแล้ว

getSelectedElements()

เลิกใช้งานแล้ว เปลี่ยนชื่อเป็น getRangeElements() แล้ว

รับองค์ประกอบทั้งหมดที่ผู้ใช้เลือกในอินสแตนซ์ที่เปิดของเอกสาร ซึ่งรวมถึง องค์ประกอบที่เลือกบางส่วนText

รีเทิร์น

RangeElement[] — อาร์เรย์ขององค์ประกอบที่เลือกหรือเลือกบางส่วน ตามลำดับที่ปรากฏในเอกสาร

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

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

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