หน้านี้ได้รับการแปลโดย Cloud Translation API

Class RangeBuilder

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

// Change the user's selection to a range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var 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` บางส่วน และองค์ประกอบทั้งหมดที่อยู่ระหว่างองค์ประกอบเหล่านั้นลงใน `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 — เครื่องมือสร้างนี้สำหรับการทำสายโซ่

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

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

`addElementsBetween(startElement, endElementInclusive)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`addRange(range)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`build()`

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

รีเทิร์น

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

`getRangeElements()`

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

รีเทิร์น

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

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

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

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

`getSelectedElements()`

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

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

รีเทิร์น

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

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

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