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 รายการและองค์ประกอบทั้งหมดระหว่างองค์ประกอบดังกล่าวลงใน RangeBuilder นี้
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderเพิ่มองค์ประกอบ Text บางส่วน 2 รายการและองค์ประกอบทั้งหมดระหว่างองค์ประกอบดังกล่าวลงใน RangeBuilder
addRange(range)RangeBuilderเพิ่มเนื้อหาของ Range อื่นลงใน RangeBuilder นี้
build()Rangeสร้าง Range จากการตั้งค่าที่ใช้กับโปรแกรมสร้าง
getRangeElements()RangeElement[]รับองค์ประกอบทั้งหมดใน Range นี้ รวมถึงองค์ประกอบ Text บางส่วน (เช่น ในกรณีที่มีการเลือกเฉพาะองค์ประกอบ Text บางส่วน)

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

addElement(element)

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

พารามิเตอร์

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

รีเทิร์น

RangeBuilder — ตัวสร้างนี้สําหรับการต่อเชื่อม

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

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

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

addElement(textElement, startOffset, endOffsetInclusive)

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

พารามิเตอร์

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

รีเทิร์น

RangeBuilder — ตัวสร้างนี้สําหรับการต่อเชื่อม

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

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

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

addElementsBetween(startElement, endElementInclusive)

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

พารามิเตอร์

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

รีเทิร์น

RangeBuilder — ตัวสร้างนี้สําหรับการต่อเชื่อม

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

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

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startTextElementTextองค์ประกอบข้อความแรกที่จะเพิ่มบางส่วน
startOffsetIntegerจํานวนของอักขระก่อนอักขระแรกของ startTextElement ที่จะรวมไว้ (นั่นคือ ดัชนีของอักขระแรกในช่วง)
endTextElementInclusiveTextองค์ประกอบข้อความสุดท้ายที่จะเพิ่มบางส่วน
endOffsetInclusiveIntegerจำนวนอักขระก่อนอักขระสุดท้ายของ endTextElementInclusive ที่จะรวมไว้ (นั่นคือ ดัชนีของอักขระสุดท้ายในช่วง)

รีเทิร์น

RangeBuilder — ตัวสร้างนี้สําหรับการต่อเชื่อม

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

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

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

addRange(range)

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

พารามิเตอร์

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

รีเทิร์น

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

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